Tracking Table
Project Name | Document Title | Document Owner (name - use @ notation) | Current Document State (as of M1) Choices:
| Activity Planned for Release Choices:
| Preliminary Documentation New docs or new projects ONLY (enter "N/A" if not applicable, or link to gerrit if completed) | Attended Doc Hackathon 1 on March 11 (Document owner must attend at least one hackathon) (fill in green checkmark | Attended Doc Hackathon 2 on March 25 (Document owner must attend at least one hackathon) (fill in green checkmark | Link to Final Documentation in ReadTheDocs (stable/guilin branch) | Reviewed by the doc project (reviewed means release related content. Such as release notes and release name were applicable) By best effort! | |
|---|---|---|---|---|---|---|---|---|---|---|
M1 | M2/M3 | Post-M4 | RC2 | |||||||
| CLAMP | Architecture | Maintained | Minor Update | N/A | ||||||
| POLICY | Architecture | Maintained | Minor Update | N/A | ||||||
| POLICY | Offered APIs | Maintained | Minor Update | N/A | ||||||
| POLICY | Development Guide | Maintained | Minor Update | N/A | ||||||
| HOLMES | Architecture | Maintained | No Change | N/A | ||||||
| HOLMES | Offered APIs | Maintained | No Change | N/A | ||||||
| HOLMES | Consumed APIs | Maintained | Minor Update | N/A | ||||||
| HOLMES | Installation | Maintained | Minor Update | N/A | ||||||
| Modeling | Architecture | Yuanhong Deng | Maintained | Minor Update | N/A | |||||
| Modeling | Offered APIs | Yuanhong Deng | Maintained | Minor Update | N/A | |||||
| VFC | Offered APIs | Yuanhong Deng | Maintained | Minor Update | N/A | |||||
| SO | Architecture | Seshu Kumar Mudiganti | Maintained | Minor Update | N/A | |||||
| SO | Offered APIs | Maintained | Minor Update | N/A | ||||||
| SO | Development Guide | Maintained | Minor Update | N/A | ||||||
| VID | Release Notes | Ittay Stern | Maintained | Minor Update | N/A | |||||
| VID | Swagger API | Ittay Stern , automatically generated | Maintained | No Change | N/A | |||||
| VID | User Guide | Ittay Stern | Maintained | No Change | N/A | |||||
| Usecase UI | Release Notes | Maintained | Minor Update | N/A | ||||||
| Usecase UI | User Guide | Maintained | Minor Update | N/A | ||||||
| Usecase UI | Installation Guide | Maintained | No Change | N/A | ||||||
| SDC | Architecture | Christophe Closset | Maintained | Minor Update | N/A | |||||
| SDC | Release Notes | Maintained | Minor Update | N/A | ||||||
| AAI | Offered APIs | Maintained | Minor Update | |||||||
| AAI | AAI REST API | William Reehil | Maintained | Minor Update | ||||||
| AAI | Release Notes | William Reehil | Maintained | Minor Update | ||||||
if attended)Procedure
M1
- Find JIRA task attached to M1 Epic for your project, if you haven't already done so.
- In the table above, fill in
- project name
- doc title,
- doc owner (use Confluence @ notation for name, e.g., David McBride)
- current doc state
- activity planned for release
- Update status of JIRA task as Done
M2/M3
- Find JIRA task attached to M2 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.
Post M4
- Find the dates for the two documentation hackathons.
- The document owner should plan on attending at least one of the two hackathons.
- Enter a green checkmark in the appropriate column in the table above for the hackathon that was attended.
RC2
- Find JIRA task attached to RC0 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.