IMPORTANT NOTE

Beginning with the 'Jakarta' release a project/repository contributing to the documentation of the release needs to ...

be actively maintained
create a branch for the new release

TABLE OF CONTENTS

Short Explanation

Table: 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).

Table: Non-Relevant Repositories

Containing documentation repositories no longer relevant for the upcoming release

Unmaintained Repositories

Beginning with the 'Jakarta' release, unmaintained projects/repositories are no longer contributing to the documentation if there is no TSC exception.

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 \| changed \| remove ; status of documentation; 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' (relevant for new repos which are participating the first time) repo 'master' exists 'latest' available in RTD Responsibility: DOC (Checkpoint)	Documentation available: RTD 'branch' repo 'branch' exists 'branch' available in RTD release notes available in RTD and updated Responsibility: DOC (Checkpoint)
	M2	M2	M2	M2	M2	M4	RC0
01	AAI	aai/aai-common	AAI Documentation Repository	Minor changes for Jakarta	William Reehil	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
02	AAI	aai/sparky-be	Sparky - Inventory UI Service	Repo status: No change Doc status: No change	William Reehil	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated (aai/aai-common)
03	CCSDK	ccsdk/apps	CCSDK APPS DOCUMENTATION REPOSITORY	Repo status: No change Doc status: No change	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated (ccsdk/distribution)
04	CCSDK	ccsdk/cds	CONTROLLER DESIGN STUDIO (CDS)	Changes expected for Jakarta	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated (ccsdk/distribution)
05	CCSDK	ccsdk/distribution	Common Controller Software Development Kit	Changes expected for Jakarta	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
06	CCSDK	ccsdk/features	SDN-R Online help	Changes expected for Jakarta	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated (ccsdk/distribution)
07	CCSDK	ccsdk/oran	ccsdk/oran	Changes expected for Jakarta	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
08	CLI	cli	ONAP CLI	Repo status: No change Doc status: No change	Former user (Deleted)	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
09	CPS	cps	CPS Documentation		Toine Siebelink	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
10	CPS	cps/cps-temporal	CPS Temporal		Former user (Deleted)	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
11	CPS	cps/ncmp-dmi-plugin	DMI-Plugin Documentation		Toine Siebelink	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
12	DCAE	dcaegen2	Data Collection Analytics and Events (DCAE)		Vijay Kumar	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
13	DMAAP	dmaap/buscontroller	dmaap/buscontroller		Fiachra Corcoran	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
14	DMAAP	dmaap/datarouter	DMaaP Data Router		Fiachra Corcoran	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
15	DMAAP	dmaap/messagerouter/messageservice	dmaap/message router(MR)		Fiachra Corcoran	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
16	DOC ArchSubCom	doc	Open Network Automation Platform ONAP Architecture	Architecture Updates	Thomas Kulik (doc) Chaker Al-Hakim	repo 'master' exists 'latest' available in RTD Architecture updated	repo branched 'branch' available in RTD release notes (doc) available in RTD and updated release notes (composite) available in RTD and updated Architecture updated
17	HOLMES	holmes/engine-management	Holmes	Installation update due to HOLMES-488 - Getting issue details... STATUS	Guangrong Fu	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated (holmes/rule-management)
18	HOLMES	holmes/rule-management	Holmes	Installation update due to HOLMES-488 - Getting issue details... STATUS	Guangrong Fu	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
19	INTEGRATION	integration	INTEGRATION		Michał Jagiełło	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
20	MODELING	modeling/etsicatalog	Etsicatalog Project	Minor changes expected for Jakarta	Yuanhong Deng	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
21	MODELING	modeling/modelspec	Model Specifications		Xu Yang	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
22	MSB	msb/apigateway	MSB(Microservices Bus)	Changes expected for Jakarta	Jinquan Ni	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
23	MSB	msb/discovery	MSB(Microservices Bus)	maintained Minor changes expected for Jakarta	Jinquan Ni	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated (msb/apigateway)
24	MSB	msb/java-sdk	MSB(Microservices Bus)	maintained Minor changes expected for Jakarta	Jinquan Ni	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated (msb/apigateway)
25	MSB	msb/swagger-sdk	Swagger SDK	Repo status: No change Doc status: No change	Jinquan Ni	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated (msb/apigateway)
26	MULTICLOUD	multicloud/framework	MultiCloud Architecture	Repo status: No change Doc status: No change	Bin Yang	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
27	MULTICLOUD	multicloud/k8s	MultiCloud Kubernetes Plugin	Minor changes expected for Jakarta	Bin Yang	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated (multicloud/framework)
28	OOM	oom	OOM Documentation Repository		no PTL since 2022-04-01	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
29	OOM	oom/offline-installer	OOM offline-installer	Repo status: No change Doc status: No change	no PTL since 2022-04-01	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes (ChangeLog) available in RTD and updated
30	OOM	oom/platform/cert-service	OOM Certification Service		no PTL since 2022-04-01	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated (changelog)
31	OOF	optf/has	Optimization Framework: Homing and Allocation	Changes expected for Jakarta	krishna moorthy	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
32	OOF	optf/osdf	Optimization Framework: Optimization Service Design Framework (OSDF)	Changes expected for Jakarta	krishna moorthy	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
33	SECCom	osa	ONAP Security		Krzysztof Opasiak	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
34	POLICY	policy/parent	Policy Framework Architecture	Changes expected for Jakarta	Liam Fallon	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
35	SDC	sdc	SDC Documentation	Minor changes for Jakarta	Michael Morris	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
36	SDNC	sdnc/oam	Network Controller (SDNC)	Changes expected for Jakarta	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
37	SO	so	ONAP SO	Minor changes expected for Jakarta	Seshu Kumar Mudiganti	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
38	UUI	usecase-ui	Usecase-UI(Use Case User Interface)	Minor changes expected for Jakarta	Keguang He	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
39	VFC	vfc/nfvo/lcm	VF-C(Virtual Function Controller)	Minor changes expected for Jakarta	Yuanhong Deng	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
40	VNFSDK	vnfsdk/model	VNFSDK Documentation	Repo status: No change Doc status: No change	Former user (Deleted)	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated

Non-Relevant 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 \| changed \| remove ; status of documentation; 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' (relevant for new repos which are participating the first time) repo 'master' exists 'latest' available in RTD Responsibility: DOC (Checkpoint)	Documentation available: RTD 'branch' repo 'branch' exists 'branch' available in RTD release notes available in RTD Responsibility: DOC (Checkpoint)
	M2	M2	M2	M2	M2	M4	RC0
01	VNFRQTS	vnfrqts/guidelines	VNF Guidelines	unmaintained	no PTL since 2021-11-01	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated (vnfrqts/requirements)
02	VNFRQTS	vnfrqts/requirements	VNF or PNF Requirements Documentation	unmaintained	no PTL since 2021-11-01	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
03	VNFRQTS	vnfrqts/testcases	VNF Test Case Descriptions	unmaintained	no PTL since 2021-11-01	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
04	VNFRQTS	vnfrqts/usecases	VNF Provider Use Cases	unmaintained	no PTL since 2021-11-01	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated
05	VVP	vvp/documentation	VVP Documentation	unmaintained	steven stark	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available in RTD and updated

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 (November 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!

To reduce complexity and to avoid confusion and misunderstanding for the reader we decided to remove documentation for unmaintained projects/repositories.

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, has changed 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)

Browser not supported