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 <date> (Document owner must attend at least one hackathon) (fill in green checkmark | Attended Doc Hackathon 2 on <date> (Document owner must attend at least one hackathon) (fill in green checkmark | 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/M3 | Post-M4 | RC2 | ||||||
HOLMES | Architecture | Maintained | Minor Update | N/A | |||||
HOLMES | Configuration | Maintained | Minor Update | N/A | |||||
HOLMES | Consumed APIs | Maintained | Minor Update | N/A | |||||
HOLMES | Human Interfaces | 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 | Maintained | Minor Update | N/A | |||||
Usecase UI | Installation Guide | Maintained | Minor Update | N/A | |||||
VFC | Architecture | 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 | 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 | Maintained | Minor Update | N/A | |||||
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 | Yuanhong Deng | 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 | 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 | Maintained | No Change | N/A | |||||
OOF | Installation | Maintained | No Change | N/A | |||||
OOF | 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 | Maintained | No Change | N/A | |||||
OOF | 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 | Maintained | No Change | N/A | |||||
OOF | 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 | |||||
CLI | user guide | Maintained | Minor updates | N/A | |||||
VNFSDK | RElease Notes | Maintained | Minot updates | N/A | |||||
VNFSDK | user guide | Maintained | Minor 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 | ||||||
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 | Maintained | Minor Update | N/A | |||||
DCAE | Architecture | Maintained | Minor Update | N/A | |||||
DCAE | Release Notes | Maintained | Minor Update | N/A | |||||
DCAE | DCAE Service Components | Maintained | Minor Update on existing components + New Honolulu components | N/A | |||||
DCAE | Consumed API's | Maintained | Minor Update | N/A | |||||
DCAE | Installation/Deployment Guide | Maintained | Minor Update | N/A | |||||
DMaaP Bus Controller | Architecture | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Bus Controller | DMaaP Buscontroller Release Notes | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Bus Controller | Configuration | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Bus Controller | Human Interfaces | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Bus Controller | Offered APIs | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Bus Controller | Installation | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Bus Controller | Environment | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Bus Controller | Consumed APIs | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Bus Controller | Administration | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Bus Controller | Logging | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Bus Controller | Delivery | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Bus Controller | Security | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Message Router | Architecture | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Message Router | Offered APIs | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Message Router | Consumed APIs | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Message Router | Delivery | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Message Router | Logging | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Message Router | Installation | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Message Router | Configuration | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Message Router | Administration | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Message Router | Human Interfaces | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Message Router | Release Notes | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Data Router | Architecture | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Data Router | Offered APIs | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Data Router | Delivery | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Data Router | Logging | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Data Router | Installation | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Data Router | Configuration | Fiachra Corcoran | Maintained | No Change | N/A | ||||
DMaaP Data Router | DMaaP Data Router Release Notes | Fiachra Corcoran | Maintained | No Change | N/A | ||||
SDC | Release Notes | Maintained | Minor Update | N/A | |||||
SDC | User Guide | Maintained | Minor Update | N/A | |||||
SDC | Administration | Christophe Closset | Maintained | No Change | N/A | ||||
SDC | Architecture | Christophe Closset | Maintained | No Change | N/A | ||||
SDC | Configuration | Christophe Closset | Maintained | No Change | N/A | ||||
SDC | Consumed APIs | Christophe Closset | Maintained | No Change | N/A | ||||
SDC | Offered APIs | Maintained | No Change | N/A | |||||
SDC | Delivery | Maintained | No Change | N/A | |||||
SDC | Human Interface | Maintained | No Change | N/A | |||||
SDC | Generic Designer Integration | Christophe Closset | Maintained | No Change | N/A | ||||
SDC | Onboarding Package Types | Christophe Closset | Maintained | No Change | N/A | ||||
SDC | External Testing | Maintained | No Change | N/A | |||||
SDC | Installation | Christophe Closset | Maintained | No Change | N/A | ||||
SDC | Logging | Christophe Closset | Maintained | No Change | N/A | ||||
SDC | SDC SDKs | MAintained | No Change | N/A | |||||
SDC | Workflow Designer | Maintained | No Change | 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 | |||||
VID | Swagger API | Maintained | No Change | N/A | |||||
VID | User Guide | Maintained | No Change | N/A | |||||
MSB | Architecture | Maintained | Minor Update | N/A | |||||
MSB | Configuration | Maintained | Minor Update | N/A | |||||
MSB | Consumed APIs | Jinquan Ni | Maintained | Minor Update | N/A | ||||
MSB | Human 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 OSullivan | Maintained | No Change | N/A | ||||
EXTAPI | Developer Guide | Adrian OSullivan | Maintained | No Change | N/A | ||||
MultiCloud | Architecture | Bin Yang | Maintained | No Change | N/A | ||||
MultiCloud | Release Notes | Bin Yang | Maintained | Minor Update | N/A | ||||
MultiCloud | Offered APIs | Bin Yang | Maintained | Minor Update | N/A | ||||
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.