Tracking Table
Project Name | Document Title | Document Owner (name) | Current Document State (as of M1) (Choices: New / Maintained) | Activity Planned for Release (Choices: Initial Publication / Major Update / Minor Update / No Change) | Preliminary Documentation New docs or new projects ONLY (enter "N/A" if not applicable, or link to gerrit if completed) | Attended Doc Hackathon 1 (Document owner must attend at least one hackathon) (fill in green checkmark if attended) | Attended Doc Hackathon 2 (Document owner must attend at least one hackathon) (fill in green checkmark if attended) | Link to Final Documentation in ReadTheDocs |
---|---|---|---|---|---|---|---|---|
M1 | M2/M3 | Post-M4 | RC0 | |||||
CLAMP | Architecture | Maintained | Minor Update | N/A | ||||
CLAMP | User Guide | Maintained | Minor Update | N/A | ||||
Modeling | Model Spec | Xu Yang | Maintained | Minor Update | N/A | |||
Modeling | ETSI Catalog | Yuanhong Deng | Maintained | Minor Update | N/A | |||
MultiCloud | Architecture | Maintained | No Change | N/A | ||||
MultiCloud | User Guide | Maintained | No Change | N/A | ||||
APPC | LCM API Guide | Takamune Cho | Maintained | Minor Update | N/A | |||
APPC | Client Library Guide | Takamune Cho | Maintained | Minor Update | N/A | |||
APPC | Logging Guide | Takamune Cho | Maintained | No Change | N/A | |||
APPC | User Guide | Takamune Cho | Maintained | Minor Update | N/A | |||
APPC | OAM API Guide | Takamune Cho | Maintained | No Change | N/A | |||
APPC | CDT User Guide | Takamune Cho | Maintained | Minor Update | N/A | |||
PORTAL | Release Notes | Lorraine Welch | Maintained | Minor Update | N/A | Did not attend | Did not attend | RC0 |
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.
RC0
- 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.