...
- 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/_docs/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.
Contributing Minor Changes
Under the minor changes, we assume the fixing of typos, misprints, or easy-to-fix unclarities. In general, you're dealing with a minor change if it takes you a longer time to create a JIRA ticket and fo
Changing the URL of an Existing Page
...