Tracking Table
Project Name | Repository (one per row) (Please list any repo that contains documentation to be published with the release) | Repository status (new, maintained, removed) | Documentation Owner(s) | Preliminary Documentation New docs or new projects ONLY (enter "N/A" if not applicable, or link to gerrit request if completed) | Link to Final Documentation in ReadTheDocs (stable/istanbul branch) | Reviewed by the doc project By best effort! |
|---|---|---|---|---|---|---|
| M2 | M4 | RC2 | Sign Off | |||
Procedure
M2
- Find JIRA task attached to M2 Epic for your project, if you haven't already done so.
- In the table above, fill in the first 4 columns:
- Project name
- Repositories that contain documentation to be published with the release (one per row)
- Does the repository contain new documentation (yes/no)
- Documentation owner(s) (use Confluence @ notation for name, e.g., David McBride)
- Update status of JIRA task as Done
M4
- Find JIRA task attached to M4 Epic for your project, if you haven't already done so.
- Note that this task applies to new documents only (i.e., "New" in Current Document State column). If this is not a new document, just enter "N/A" in the Preliminary Documentation Completed column in the table above.
- For new documents, at a minimum create a placeholder document (e.g., document with a title, or an outline), and commit to the repo. Add a link to the gerrit to the Preliminary Documentation column in the table above.
- Update the status of the JIRA task as Done.
RC2
- Find JIRA task attached to RC2 Epic for your project, if you haven't already done so.
- Add a link to the document in ReadTheDocs in the appropriate column in the table above.
- Update the status of the JIRA task as Done.