Versions Compared

Old Version 15

changes.mady.by.user Denis Magda

Saved on

compared with

New Version 16

changes.mady.by.user Denis Magda

Saved on

Key

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

...

  1. Clone the main Ignite repository and get to know our development process.
  2. Install Jekyll: TBD
  3.  You can fork the repository or have a clone of the main repository on your local machine.
  4. Make sure a JIRA ticket is created for the change and the component property is set to documentation.

  5. 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. 

  6. Do a grammar check of your changes. Use Grammarly if you don't have a more advanced tool at hand.

  7. Build the docs locally to test that your changes are applied properly and you didn't break anything.

  8. If you added a new page or imported any external files, run the license checker: `mvn clean validate -DskipTests=true -P check-licenses`

    the top.

    Grammarly



Changing the URL of an Existing Page

...