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.
(optional) 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 to the Ignite master, 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.
If applicable, cherry-pick the commit to the latest version of the docs (that is already published on the website or to be released).

Cherry-pick a commit from the master into ignite-{version} branch.
If ignite-{version} is the latest version that is already published on the website, then republish the docs following this process: Updating Published Docs

Changing an URL of an Existing Page

...

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

...

./build.sh --version=3.0.0-alpha1 --github-branch=ignite-3.0.0-alpha1

Updating Published Docs

The GitHub Action is used to automatically update documentation for released versions. (Supports 2.x versions since 2.10)

The push event to a released branch triggers script to publish changes to the site.

Commit changes to the Ignite repository and make sure that the site updated.

Use the same command to generate an updated version of already released docs:

./build.sh --version=2.9.1 0 --github-branch=ignite-2.9.1-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

There is a "Docs Feedback" button in the bottom right corner of all documentation pages, which allows anyone to leave comments.

...