Table of Contents

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:

...

Clone the main Ignite repository and get to know our development process. You can fork the repository or have a clone of the main repository on your local machine.
Make sure a JIRA ticket is created for the change and the component property is set to documentation.
Find documentation sources under the ignite_root/docs/_docs directory and do necessary modifications:
- Refer to the How to Contribute section of the documentation module to understand the syntax of the AsciiDoc format and the rest of the files located under the _docs directory.
- Update the ignite_root/docs/_data/toc.yaml file if you add a new documentation page.
- Every new documentation page must include the Apache 2.0 license header.
Do a grammar check of your changes. Use Grammarly if you don't have a more advanced tool at hand.
Build the docs locally to test that your changes are applied properly and you didn't break anything.
If you added a new page or imported any external files, run the license checker: `mvn clean validate -DskipTests=true -P check-licenses`
Send a pull-request, request the review from documentation maintainers.
Merge the changes after passing the review and after you confirm that all the automated checks performed by Travis CI are passed.

...

Check if the ignite-{version}-docs branch has already been created after the version was released.
If the branch doesn't exist, create it from the ignite-{version} branch.
Commit the changes to the Ignite master.
Cherry-pick the changes to the ignite-{version}-docs branch.
Made the change visible on the website: Updating Published Docs

Changing an URL of an Existing Page

...

Reach out to documentation maintainers if you need any help with this.

...

As for the rest, follow the procedure described in the Publishing New Version section above.

...