Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated instructions for building new docs.

...

  1. Pull the latest changes from the website's master branch.
  2. Go to the ignite_website_root/_docs directory.
  3. Run the `./build.sh --version={version} --github-branch={branch} --latest` command to transform the docs from the AsciiDoc to the HTML format, and add the HTML files to the website repository
    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 1 --github-branch=IGNITEignite-2.9.1 --latest
  4. Change Check that the version of the docs was generated without issues using your local installation of the website: http://localhost/docs/latest/
  5. In order to update all internal links on the previous ‘latest’ docs and to add `noindex`, it’s necessary to rebuild it. This is done by repeating step #3, but without the `--latest` parameter and using the previous version data.
    For example:
    ./build.sh --version=2.9.0 --github-branch=ignite-2.9-docs
  6. Push the generated files to the ignite website master. They will be published automatically.
  7. Check that the version was published successfully on the Ignite website: https://ignite.apache.org/docs/latest/

...

Use the same command to generate an updated version of already released docs but do NOT specify the "–latest" flag:

 ./build.sh --version=2.8.0 --github-branch=IGNITE-2.8-docs

As for the rest, follow the procedure described in the Publishing New Version section above, except for step #5.

If you are rebuilding the docs for the latest Ignite version, remember to use '--latest' flag 


Documentation Maintainers

...