Tracking Table

Project Name	Document Title	Document Owner (name - use @ notation)	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 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)
M1					M3	Post-M3	RC2
HOLMES	Architecture	Guangrong Fu	Maintained	Minor Update	N/A
HOLMES	Configuration	Guangrong Fu	Maintained	Minor Update	N/A
HOLMES	Consumed APIs	Guangrong Fu	Maintained	Minor Update	N/A
HOLMES	Human Interfaces	Guangrong Fu	Maintained	Minor Update	N/A
HOLMES	Installation	Guangrong Fu	Maintained	Minor Update	N/A
HOLMES	Logging & Diagnostic Information	Guangrong Fu	Maintained	Minor Update	N/A
HOLMES	Release Notes	Guangrong Fu	Maintained	Minor Update	N/A
Usecase UI	Release Notes	xu ran	Maintained	Minor Update	N/A
Usecase UI	User Guide	xu ran	Maintained	Minor Update	N/A
Usecase UI	Installation Guide	xu ran	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	Minor Update	N/A
VFC	Release Notes	Yuanhong Deng	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	Xu Yang	Maintained	Minor Update	N/A
Modeling Subcommittee	Release Notes	Xu Yang	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	krishna moorthy	Maintained	No Change	N/A
OOF	Offered APIs	krishna moorthy	Maintained	No Change	N/A
OOF	Consumed APIs	krishna moorthy	Maintained	Minor updates	N/A
OOF	Logging	krishna moorthy	Maintained	No Change	N/A
OOF	Installation	krishna moorthy	Maintained	No Change	N/A
OOF	Configuration	krishna moorthy	Maintained	No Change	N/A
OOF	Administration	krishna moorthy	Maintained	No Change	N/A
OOF	Release Notes	krishna moorthy	Maintained	Minor updates	N/A
OOF	HAS - Python/Linux Distribution Notes	krishna moorthy	Maintained	No Change	N/A
OOF	HAS - Homing Specification Guide	krishna moorthy	Maintained	No Change	N/A
OOF	HAS - Example Homing Templates	krishna moorthy	Maintained	No Change	N/A
OOF	OSDF - Delivery	krishna moorthy	Maintained	No Change	N/A
OOF	OSDF - Human Interfaces	krishna moorthy	Maintained	No Change	N/A
OOF	Upgrade Strategy	krishna moorthy	Maintained	No Change	N/A
OOF	CMSO Service API	krishna moorthy	Maintained	No Change	N/A
OOF	CMSO Optimizer API	krishna moorthy	Maintained	No Change	N/A
OOF	CMSO Ticket Management API	krishna moorthy	Maintained	No Change	N/A
OOF	CMSO Topology API	krishna moorthy	Maintained	No Change	N/A
OOF	OOF CMSO Delivery	krishna moorthy	Maintained	No Change	N/A
OOF	CMSO - Human Interfaces	krishna moorthy	Maintained	No Change	N/A
OOF	CMSO - Glossary	krishna moorthy	Maintained	No Change	N/A
OOF	Example CMSO Messages	krishna moorthy	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	Jim Hahn	Maintained	Minor updates	N/A
Policy	Exposed APIs	Jim Hahn	Maintained	Minor updates	N/A
Policy	Release notes	Jim Hahn	Maintained	Minor updates	N/A
CLI	RElease Notes	user-67d6f	Maintained	Minot updates	N/A
CLI	user guide	user-67d6f	Maintained	Minor updates	N/A
VNFSDK	RElease Notes	user-67d6f	Maintained	Minot updates	N/A
VNFSDK	user guide	user-67d6f	Maintained	Minor updates	N/A
CPS	Architecture	Toine Siebelink	New	Initial Publication
CPS	Exposed API	Toine Siebelink	New	Initial Publication
CPS	Consumed API	Toine Siebelink	New	Initial Publication
CPS	Release Notes	Toine Siebelink	New	Initial Publication
CCSDK	ORAN-A1 User Guide	John Keeney	Maintained	Minor update	Developer's Guide (latest)
CCSDK	ORAN-A1 Policy API	John Keeney	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	Yuriy Malakov	Maintained	Minor update	N/A
CCSDK	Release Notes	Dan Timoney	Maintained	Minor update	N/A
SDNC	Offered APIs	Dan Timoney	Maintained	Minor Update	N/A
SDNC	Release Notes	Dan Timoney	Maintained	Minor Update	N/A
DCAE	Architecture	Vijay Venkatesh Kumar	Maintained	Minor Update	N/A
DCAE	Release Notes	Vijay Venkatesh Kumar	Maintained	Minor Update	N/A
DCAE	DCAE Service Components	Vijay Venkatesh Kumar	Maintained	Minor Update on existing components + New Honolulu components	N/A
DCAE	Consumed API's	Vijay Venkatesh Kumar	Maintained	Minor Update	N/A
DCAE	Installation/Deployment Guide	Vijay Venkatesh Kumar	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	Christophe Closset	Maintained	Minor Update	N/A
SDC	User Guide	Christophe Closset	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	Christophe Closset	Maintained	No Change	N/A
SDC	Delivery	Christophe Closset	Maintained	No Change	N/A
SDC	Human Interface	Christophe Closset	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	Christophe Closset	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	Christophe Closset	MAintained	No Change	N/A
SDC	Workflow Designer	Christophe Closset	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	William Reehil	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	Ikram Ikramullah	Maintained	Minor Update	N/A
VID	Swagger API	Ikram Ikramullah	Maintained	No Change	N/A
VID	User Guide	Ikram Ikramullah	Maintained	No Change	N/A
MSB	Architecture	Jinquan Ni	Maintained	Minor Update	N/A
MSB	Configuration	Jinquan Ni	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	Jinquan Ni	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

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.

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.

Space shortcuts

Page tree

Tracking Table

Procedure

M1

M3

Post M3

RC2

Space shortcuts

Page tree

Honolulu Documentation

Tracking Table

Procedure

M1

M3

Post M3

RC2