...
- Set up the website locally: Website Development
- Install the Jekyll toolchain following this instruction: https://jekyllrb.com/docs/installation/
Publishing New Version
- 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)
- Checkout the ignite-{version} Pull the latest changes from the website's master branch.
- Go to the ignite_website_root/_docs directory.
- 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 - Check that the version of the docs was generated without issues using your local installation of the website: http://localhost/docs/latest/
- 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 - Push the generated files to the ignite website master. They will be published automatically.
- Check that the version was published successfully on the Ignite website: https://ignite.apache.org/docs/latest/
...
{"serverDuration": 180, "requestCorrelationId": "bc305bea65e3258b"}