Documentation

Documentation agreements

Before moving a Jira ticket to testing, developers will review the documentation. For big features, if an epic branch is used, documentation will be added before moving the epic branch to QA.

• Features tickets - When a new feature is added, documentation on how to use it will be added. When the ticket is an enhancement to an existing feature, check if the existing documentation is still relevant or needs to be updated.
• Bugs tickets - Check if the existing documentation is still relevant or needs to be updated to reflect the fix.

Documentation pull request steps

1. Open a docs PR to the main ticket branch
2. Add the team-tracker-docs as a reviewer
3. Add the docs PR link in the Jira ticket so QA will know where to find it
4. Once approved, merge the docs PR in the main PR so that the changes are released together when merging to master

Reminders

When writing documents, keep in mind that these are not intended for end users, but rather to guide administrators in configuring the instance.