Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 4.06 KB

README.md

File metadata and controls

89 lines (68 loc) · 4.06 KB
Raw

elastic.io Documentation

This repository contains the documentation of the elastic.io iPaaS platform. Visit the doc.elastic.io to see it live.

Contributing

Contributions are welcome. If you create a pull request with some changes, we will review and incorporate as appropriate.

Style Guidelines

  • In order to maximize re-use for white-label customers who run elastic.io software under a different brand, it is important to use the handlebars replacements when appropriate. For example, instead of referencing elastic.io within a document, {{site.data.tenant.name}} should be used instead. A full list of substitution values can be found here.
  • All git commits should have meaningful messages. Related commits should be combined into a single commit.
  • Commits should be ideally be scoped to a single feature as much as possible.

White-labeling

(Follow the instructions in this section if you wish to set up a white-labeled copy of the documentation.)

To provide a white-labeled documentation to your customers, please follow the following steps:

  1. Fork this repository
  2. Customize variables used in documentation pages
  3. Customize the styles
  4. Customize your Algolia configuration in the _config.yml file (application_id, index_name and search_only_api_key) or delete them if you don't need search
  5. Customize CNAME file (OPTIONAL: This is only required if documentation hosted on GitHub, but not necessary if documentation hosted on servers)
  6. DO NOT edit any content to avoid merging conflicts
  7. Pull changes from the original repository regularly so that your docs are up-to-date

Creating Algolia configuration

(Required to have search run on a white-labeled instance. Local dev runs fine without this step.)

As a part of white-labelling you must take care of your own configuration to build the search statistics. To do so, create an Algolia account and use your own keys in the setup as explained here.

  1. Sign-up or sign-in

  2. Go to “Indices” section and add new index: algolia2

  3. Here is your index_name: algolia3

  4. Find application_id and search_only_api_key in “API Keys” section: algolia4

  5. Now you can Customize your Algolia configuration in the _config.yml file

Testing locally

If you don't have the jekyll/jekyll Docker image on your machine yet, install it once.

docker pull jekyll/jekyll

Once you have jekyll/jekyll image locally, execute the following command from the root folder of this repo:

./start.sh

If you are on a Windows machine just copy the command from the start.sh file and adjust it with Windows specific commands.

If your see the following output in the terminal, the docs are up and running:

No active host found
Error getting IP address: Host is not running
Configuration file: /srv/jekyll/_config.yml
Configuration file: /srv/jekyll/_config.yml
            Source: /srv/jekyll
       Destination: /srv/jekyll/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
                    done in 0.672 seconds.
 Auto-regeneration: enabled for '/srv/jekyll'
Configuration file: /srv/jekyll/_config.yml
    Server address: http://0.0.0.0:4000/
  Server running... press ctrl-c to stop.

The docs are available now at http://localhost:4000/.