Overview

Ignite documentation sources are stored in the main Ignite repository together with the rest of the Ignite source code. The docs are written in the AsciiDoc format and transformed into the HTML form with the Jekyll toolchain. The published HTML version of the docs, that is accessible under the URL https://ignite.apache.org/docs/, is stored in the Ignite Website repository. The picture below explicates on how the things are tethered together:

The sections below cover the code contribution and publication processes in detail. 

• Follow this instruction to install `jekyll` and `asciidoctor` on your machine: https://github.com/apache/ignite/blob/IGNITE-7595/docs/README.adoc
• Check out the apache ignite web-site repository (https://github.com/apache/ignite-website)
• Go to the "_docs" folder
• Run `./build.sh --version={version} --github-branch={branch} --latest`
  The script pulls the given branch from the apache-ignite code base repository and generates the docs from the adoc files. The resulting HTML files are located in the "/docs" directory.
  For example:
  ./build.sh --version=2.9.0 --github-branch=IGNITE-7595
   
• Push the generated files to master. They will be published automatically.