Tracking Table
Project Name | Document Title | Document Owner (name - use @ notation) | Current Document State (as of M1) Choices: | 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 on <date> (Document owner must attend at least one hackathon) (fill in green checkmark if attended) | Attended Doc Hackathon 2 on <date> (Document owner must attend at least one hackathon) (fill in green checkmark if attended) | Link to Final Documentation in ReadTheDocs (stable/honolulu 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/M4HOLMES | Human Interfaces | HOLMES | Consumed APIs | | Maintained | Minor Update | N/A | | Maintained | Minor Update | N/A |
HOLMES | Installation | | Maintained | Minor Update | N/A |
HOLMES | Logging & Diagnostic Information | | Maintained | Minor Update | N/A | HOLMES | Release Notes | | Maintained | Minor Update | N/A |
Usecase UI | Release Notes | | Maintained | Minor Update | N/A | Usecase UI | User Guide | xu ran | Maintained | Minor Update | N/A |
Usecase UI | Installation Guide | | Maintained | Minor Update | N/A | VFC | Architecture | Yuanhong Deng | Maintained | Minor Update | N/A |
VFC | Offered APIs | Yuanhong Deng | Maintained | No Change | N/A | VFC | Consumed APIs | Yuanhong Deng | Maintained | No Change | N/A | VFC | Delivery | Yuanhong Deng | Maintained | Minor Update | N/A |
VFC | Logging & Diagnostic Information | Yuanhong Deng | Maintained | No Change | N/A | VFC | Installation and User Guide | Yuanhong Deng | Maintained | No Change | N/A | VFC | Release Notes | | Modeling | Architecture | Yuanhong Deng | Maintained | No Change | N/A | Modeling | Offered APIs | Yuanhong Deng | Maintained | Minor Update | N/A |
Modeling | Consumed APIs | Yuanhong Deng | Maintained | No Change | N/A | Modeling | Installation | Yuanhong Deng | Maintained | Minor Update | N/A | Modeling | Release Notes | | Maintained | Minor Update | N/A |
Modeling Subcommittee | Modeling Specs | | Maintained | Minor Update | N/A | Modeling Subcommittee | Release Notes | | Maintained | Minor Update | N/A | SO | Release Notes | Seshu Kumar Mudiganti | Maintained | Minor Update | N/A | SO | Architecture | Seshu Kumar Mudiganti | Maintained | Minor Update | N/A | SO | User Guide | Seshu Kumar Mudiganti | Maintained | Minor Update | N/A |
OOF | Architecture | | Maintained | No Change | N/A | OOF | Offered APIs | | Maintained | No Change | N/A | OOF | Consumed APIs | | Maintained | Minor updates | N/A | OOF | Logging | krishna moorthyOOF | Installation | | Maintained | No ChangeOOF | Configuration | | Maintained | No Change | N/A | OOF | Administration | | Maintained | No Change | N/A | OOF | Release Notes | krishna moorthy | Maintained | Minor updates | N/A | OOF | HAS - Python/Linux Distribution Notes | | Maintained | No Change | N/A | OOF | HAS - Homing Specification Guide | | Maintained | No Change | N/A | OOF | HAS - Example Homing Templates | krishna moorthyOOF | OSDF - Delivery | | Maintained | No Change | N/A | OOF | OSDF - Human Interfaces | | Maintained | No Change | N/A | OOF | Upgrade Strategy | | Maintained | No Change | N/A | OOF | CMSO Service API | krishna moorthyOOF | CMSO Optimizer API | | Maintained | No Change | N/A | OOF | CMSO Ticket Management API | | Maintained | No Change | N/A | OOF | CMSO Topology API | | Maintained | No Change | N/A | OOF | OOF CMSO Delivery | | Maintained | No Change | N/A | OOF | CMSO - Human Interfaces | | Maintained | No Change | N/A | OOF | CMSO - Glossary | | Maintained | No Change | N/A | OOF | Example CMSO Messages | | Maintained | No Change | N/A | DOC | Project specific release note | Sofia Wallin | Maintained | Minor updates | N/A | DOC | Composite release note | Sofia Wallin | Maintained | Minor updates | N/A | DOC | Landing page | Sofia Wallin | Maintained | Minor updates | N/A | Policy | Architecture | | Maintained | Minor updates | N/A | Policy | Exposed APIs | | Maintained | Minor updates | N/A | Policy | Release notes | | Maintained | Minor updates | N/A | CLI | RElease Notes | | Maintained | Minot updates | N/A | VNFSDK | RElease Notes | | Maintained | Minot updates | N/A | CPS | Architecture | | New | Initial Publication | CPS | Exposed API | | New | Initial Publication | CPS | Consumed API | | New | Initial Publication | CPS | Release Notes | | New | Initial Publication | CCSDK | ORAN-A1 User Guide | | Maintained | Minor update | Developer's Guide (latest) | CCSDK | ORAN-A1 Policy API | | New | Updated from Guilin | - API: HTML (latest)
- API: YAML (latest)
- Note:
- v2 is the "new" API
- v1 is "old" API - being deprecated
| CCSDK | CDS User Guide | | Maintained | Minor update | N/A | CCSDK | Release Notes | Dan Timoney | Maintained | Minor update | N/A | SDNC | Offered APIs | Dan Timoney | Maintained | Minor Update | SDNC | Release Notes | Dan Timoney | Maintained | Minor Update | N/A |
DCAEArchitecture | Vijay Venkatesh KumarDCAERelease Notes | Vijay Venkatesh KumarHuman Interfaces | Jinquan Ni | Maintained | Minor Update | N/A |
DCAEDCAE Service Components | Vijay Venkatesh Kumar on existing components + New Honolulu componentsDCAE | Consumed API's | Vijay Venkatesh Kumar
|
|
|
|
MSB | User Guide | | Maintained | Minor Update | N/A |
DCAE | Installation/Deployment Guide | Vijay Venkatesh KumarN/A | SDC | Release Notes | | Maintained | Minor Update | N/A | SDC | User Guide | | Maintained | Minor Update | N/A | VVP | Release Notes | steven stark | Maintained | Minor Update | N/A |
VVP | User Guide | steven stark | Maintained | No Change | N/A | VVP | How To Contribute | steven stark | Maintained | No Change | N/A | AAI | Offered APIs | | Maintained | Minor Update | N/A | AAI | AAI REST API | William Reehil | Maintained | Minor Update | N/A | AAI | Release Notes | William Reehil | Maintained | Minor Update | N/A | VID | Release Notes | | Maintained | Minor Update | N/A | MSB | Architecture | | Maintained | Minor Update | N/A | MSB | Configuration | Jinquan Ni | Maintained | Minor Update | N/A |
MSBConsumed Jinquan NiMSBHuman Interfaces | Jinquan Ni | Maintained | Minor Update | N/A |
MSB | Installation | Jinquan Ni | Maintained | Minor Update | N/A | MSB | User Guide | | Maintained | Minor Update | N/A | EXTAPI | Architecture | Adrian OSullivan | Maintained | Minor Update | N/A | EXTAPI | Offered APIs | Adrian OSullivan | Maintained | No Change | N/A | EXTAPI | Consumed APIs | Adrian OSullivan | Maintained | Minor Update | N/A |
EXTAPI | Installation | Adrian OSullivanEXTAPI | Developer Guide | Adrian OSullivanProcedure
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
...
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
...
M3
- 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.
...