Short Explanation

Maintained Repositories

• Containing documentation repositories for the upcoming release
• Table handled commonly by the ONAP projects and the Documentation team.
• In the column header you find the responsibility for this column (DOC|PROJECT).

Unmaintained Repositories

•  Existing repositories containing documents,
  •  which are belonging to an active project, but not used in the ONAP documentation
  •  which are belonging to an unmaintained project, but used in the ONAP documentation
• Table handled mainly by DOC, but PROJECTS are asked to check if status of repository has changed.
• A request to the PROJECTS: Please check the table "Unmaintained Repositories" and move entry to the upper table, if the repository is once again maintained in the target release!

Maintained Repositories Table

Project Name (common abbreviation of the project or subcommittee) Responsibility: Prefill: DOC Update: PROJECT	Repository Name (contains documentation to be published with the upcoming release) Responsibility: Prefill: DOC Update: PROJECT	ReadTheDocs Link (link pointing to RTD 'latest' main index.rst; main title used in index.rst) Responsibility: Prefill: DOC Update: PROJECT	Repository Status (new | maintained | remove ; needed to e.g. identify changes in the intersphinx linking) Responsibility: PROJECT	Documentation Owner(s) (responsible for documentation in this repo; please use @ notation for the name) Responsibility: PROJECT	Documentation available: RTD 'latest' o   repo 'master' exists o   available @ RTD 'latest' Responsibility: DOC (Checkpoint)	Documentation available: RTD 'branch' o   repo 'branch' exists o   available @ RTD 'branch' o   release notes are final Responsibility: DOC (Checkpoint)
M2	M2	M2	M2	M2	M4	RC0
AAI	aai/aai-common	AAI Documentation Repository	Maintained	William Reehil		repo branched branch available in RTD release notes available
AAI	aai/sparky-be	Sparky - Inventory UI Service	Maintained	William Reehil		repo branched branch available in RTD release notes available  (AAI common)
CCSDK	ccsdk/cds	CONTROLLER DESIGN STUDIO (CDS)	Maintained	Dan Timoney		repo branched branch available in RTD release notes available  (CCSDK)
CCSDK	ccsdk/distribution	Common Controller Software Development Kit	Maintained	Dan Timoney		repo branched branch available in RTD release notes available
CCSDK	ccsdk/features	SDN-R Online help	Maintained	Dan Timoney		repo branched branch available in RTD release notes available (CCSDK)
CCSDK	ccsdk/oran	ccsdk/oran	Maintained	Dan Timoney		repo branched branch available in RTD release notes available (CCSDK)
CLI	cli	ONAP CLI	Maintained	user-67d6f		repo branched branch available in RTD release notes available
CPS	cps	CPS Documentation		Toine Siebelink		repo branched branch available in RTD release notes available
CPS	cps/cps-temporal	CPS Temporal Documentation	new	Bruno Sakoto		repo branched branch available in RTD  release notes available
CPS	cps/ncmp-dmi-plugin	CPS NCPM DMI Plugin Documentation	new	Toine Siebelink		repo branched branch available in RTD  release notes available
DCAE	dcaegen2	Data Collection Analytics and Events (DCAE)	maintained	Vijay Venkatesh Kumar		repo branched branch available in RTD release notes available
DMAAP	dmaap/buscontroller	dmaap/buscontroller	maintained	Fiachra Corcoran		repo branched branch available in RTD release notes available
DMAAP	dmaap/datarouter	DMaaP Data Router	maintained	Fiachra Corcoran		repo branched branch available in RTD release notes available
DMAAP	dmaap/dbcapi	DMaaP Bus Controller REST API	remove	Fiachra Corcoran	is already removed from ONAP Component List, will be moved to table below...	NO LONGER USED To be removed from the table??
DMAAP	dmaap/messagerouter/messageservice	dmaap/message router(MR)	maintained	Fiachra Corcoran		repo branched branch available in RTD release notes available
DOC ArchSubCom	doc	Open Network Automation Platform	maintained (doc) ??? (architecture)	Thomas Kulik (doc) ?? (architecture)	(Doc) (Architecture)	repo branched branch available in RTD  release notes available
HOLMES	holmes/engine-management	Holmes	maintained	Guangrong Fu		repo branched branch available in RTD release notes available (rule-management)
HOLMES	holmes/rule-management	Holmes	maintained	Guangrong Fu		repo branched branch available in RTD  release notes available
INTEGRATION	integration	INTEGRATION	maintained	Michał Jagiełło		repo branched branch available in RTD release notes available
MODELING	modeling/etsicatalog	Etsicatalog Project	maintained	Yuanhong Deng		repo branched (Istanbul; capital "I") branch available in RTD release notes available
MODELING	modeling/modelspec	Model Specifications			missing info	repo branched branch available in RTD release notes available
MSB	msb/apigateway	MSB(Microservices Bus)	maintained	Jinquan Ni		repo branched branch available in RTD release notes available
MSB	msb/discovery	MSB(Microservices Bus)	maintained	Jinquan Ni	no documentation and not referenced (see table below)
MSB	msb/java-sdk	MSB(Microservices Bus)	maintained	Jinquan Ni	no documentation and not referenced (see table below)
MULTICLOUD	multicloud/framework	MultiCloud Architecture	maintained	Bin Yang		repo branched branch available in RTD release notes available
OOM	oom	OOM Documentation Repository	maintained	Sylvain Desbureaux		repo branched branch available in RTD release notes available
OOM	oom/offline-installer	OOM offline-installer	maintained	Sylvain Desbureaux		repo branched branch available in RTD release notes not required
OOM	oom/platform/cert-service	OOM Certification Service	maintained	Sylvain Desbureaux		repo branched branch available in RTD release notes available
OOF	optf/cmso	Optimization Framework: Change Management Schedule Optimization	remove	krishna moorthy	will be removed from ONAP Component List	To be removed from the table NOT PART OF RELEASE
OOF	optf/has	Optimization Framework: Homing and Allocation	maintained	krishna moorthy		repo branched branch available in RTD release notes available
OOF	optf/osdf	Optimization Framework: Optimization Service Design Framework (OSDF)	maintained	krishna moorthy		repo branched branch available in RTD release notes available
SECCom	osa	ONAP Security	maintained	Krzysztof Opasiak		not applicable (always latest)
POLICY	policy/parent	Policy Framework Architecture	maintained	Liam Fallon		repo branched branch available in RTD release notes available (not cherry-picked)
SDC	sdc	SDC Documentation	maintained	Michael Morris		repo branched branch available in RTD  release notes available
SDNC	sdnc/oam	Network Controller (SDNC)	Maintained	Dan Timoney		repo branched branch available in RTD  release notes available
SO	so	ONAP SO	Maintained	Seshu Kumar Mudiganti		repo branched branch available in RTD release notes available (merge required)
UUI	usecase-ui	Usecase-UI(Use Case User Interface)	maintained	xu ran		repo branched branch available in RTD release notes available (not cherry-picked)
VFC	vfc/nfvo/lcm	VF-C(Virtual Function Controller)	maintained	Yuanhong Deng		repo branched (Istanbul; capital "I") branch available in RTD release notes available
VNFRQTS	vnfrqts/guidelines	VNF Guidelines	maintained	Trevor Lovett		repo branched branch available in RTD release notes not required
VNFRQTS	vnfrqts/requirements	VNF or PNF Requirements Documentation	maintained	Trevor Lovett		repo branched branch available in RTD release notes available (merge conflict)
VNFRQTS	vnfrqts/testcases	VNF Test Case Descriptions	maintained	Trevor Lovett		repo branched branch available in RTD release notes available
VNFRQTS	vnfrqts/usecases	VNF Provider Use Cases	maintained	Trevor Lovett		repo branched branch available in RTD release notes available
VNFSDK	vnfsdk/model	VNFSDK Documentation	Maintained	user-67d6f		repo branched  available in RTD release notes available
VVP	vvp/documentation	VVP Documentation	maintained	steven stark		repo branched branch available in RTD release notes available

Unmaintained Repositories Table

Reason for the Documentation Tracking Page

We as the doc team are responsible for providing the right set of documentation specific for every ONAP release. This release-specific set of documentation always consists of a large number of text files, formatted in the restructuredText markup language and spread over a large number of repositories. The documentation files are interlinked by the doc team using intersphinx linking functionality and config files residing in the branched doc repo. The documentation is build automatically and can be found in ReadTheDocs by choosing the respective release name. Some numbers for the Guilin release may show the scale:

• 987 text files (out of 1296 in master)
• spread over 58 repositories (out of 97 in master)
• grouped in 26 projects (out of 37 in master)

Please note that we are counting only repos and projects which contain docs in the Guilin release! And also note, that the numbers do not include text files, repositories and projects for components that are added to the release by the OOM team (see below). Those must be added to the above listed numbers!

To create a release-specific set of documentation it is essential for the doc team to know, which components are part of the upcoming ONAP release. To be more concrete: We need to know which components are deployed when ONAP is installed via OOM. And we need to know this on repository level - not on project or container level because documentation files are found in the repositories for the deployed ONAP components.

As of now (April 2021) an ONAP release deployed via OOM consists of components whose underlying repositories include documentation and where the repositories ...

• are actively maintained by the project, have branched for the upcoming release and are part of it
• or actively maintained by the project, have never branched but are also part of the upcoming ONAP release
• or no longer maintained by anyone (unmaintained state), have not branched for the upcoming but for an earlier release and are part of the upcoming ONAP release for a good reason
• or no longer maintained by anyone (unmaintained state), have never branched but are part of the upcoming ONAP release for a good reason

In addition (and unfortunately) components exist where the repositories ...

• are actively maintained by the project, have branched for the upcoming release but they are not part of the upcoming release.

This makes it very difficult to identify ...

• the required components, the documentation files and their correct version for the upcoming release and
• the appropriate steps which have to be taken by the doc team to prepare the release-specific set of documentation (e.g. intersphinx linking).

But with the tables on this page and a little help from the projects and release management it will be possible to identify all relevant files and related actions. Only the first table must (partly) be maintained by the projects!

Our target on mid- / longterm is to ged rid of manually filling out this table. Any good idea and your feedback is welcome here! Do not hesitate to contact the documentation team.

Notes for "Maintained Repositories" 

In the table "Maintained Repositories" please check/update:

Project Name: Use the common abbreviation of the project or subcommittee.

Repository Name: Containing documentation to be published with the release (one per line)

ReadTheDocs Link: Link pointing to RTD 'latest' main index.rst. Main title used in index.rst.

Repository Status: Please note if the repository is new, was maintained or must be removed. For new documents, at a minimum create a placeholder document (e.g., document with the correct file name and a title, or an outline), and commit to the repo. This is important for the doc team to check whether i.e. the linking works or not.

Documentation Owner(s): Please name responsible persons for documentation in this repo. Please use @ notation (e.g. David McBride for the name)

A request to the PROJECTS: Please check the table "Unmaintained Repositories" and move entry to the upper table, if the repository is once again maintained in the target release!