Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. The docs are always published from a release-specific branch, such as ignite-2.9.1 (the only exception is version 2.9.0 that was published from ignite-2.9.1-docs)
  2. In the release branch, open the docs/_config.yml file and update the version property with the release number.
  3. Push all the changes to the release branch.
  4. Checkout the ignite-{version} branch.website repo: Website Development
  5. Go to the ignite_website_root/_docs directory.
  6. 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.1 --github-branch=ignite-2.9.1 --latest
  7. Check that the version of the docs was generated without issues using your local installation of the website: http://localhost/docs/latest/
  8. 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
  9. Update the following line in .htaccess file so the /docs/latest/ redirects to the new version: 
    RewriteRule ^docs/latest/(.*)$ /docs/2.9.1/$1 [L]
  10. Push the generated files to the ignite website master. They will be published automatically.
  11. Check that the version was published successfully on the Ignite website: https://ignite.apache.org/docs/latest/

...