Versions Compared

Key

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

...

The sections below cover the code contribution and publication processes in detail. 

Contributing to Documentation

The documentation contribution process adheres to the main contribution process with several minor adjustments when it comes to the minor edits, fixing typos, or doing little corrections. For instance, while you always need to create a JIRA ticket for significant documentation changes and follow the main contribution process, with minor changes (such as typos correction) a committer can take a shortcut and commit a change to the repo without the need of having a respective JIRA ticket. 

Contributing Significant Changes

Under significant changes, we assume new features, notable rework on an existing documentation page, any other changes that require review by community members. Follow this process to contribute a significant documentation change:

  1. Clone the main Ignite repository and get to know our development process.
  2. Install Jekyll: TBD
  3. Make sure a JIRA ticket is created for the change and the component property is set to documentation.
  4. Find documentation sources under the ignite_root/docs/_docs directory and do necessary modifications.

    • Update the ignite_root/docs/_docs/toc.yaml file if you add a new documentation page.
    • Every new documentation page must include the license header at the top.
  5. Grammarly

Changing the URL of an Existing Page


Publishing to the Website

...