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

Non-Relevant Repositories

Containing documentation repositories no longer relevant for the upcoming release

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' repo 'master' exists 'latest' available in RTD Responsibility: DOC (Checkpoint)	Documentation available: RTD 'branch' repo 'branch' exists 'branch' available in RTD release notes available Responsibility: DOC (Checkpoint)
M2	M2	M2	M2	M2	M4	RC0
AAI	aai/aai-common	AAI Documentation Repository	Maintained	William Reehil	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
AAI	aai/sparky-be	Sparky - Inventory UI Service	Maintained	William Reehil	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available (AAI common)
CCSDK	ccsdk/cds	CONTROLLER DESIGN STUDIO (CDS)	Maintained	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available (CCSDK)
CCSDK	ccsdk/distribution	Common Controller Software Development Kit	Maintained	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
CCSDK	ccsdk/features	SDN-R Online help	Maintained	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available (CCSDK)
CCSDK	ccsdk/oran	ccsdk/oran	Maintained	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available (CCSDK)
CLI	cli	ONAP CLI	Maintained	Former user (Deleted)	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD - no changes - release notes not required
CPS	cps	CPS Documentation		Toine Siebelink	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
CPS	cps/cps-temporal	CPS Temporal	new	Former user (Deleted)	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
CPS	cps/ncmp-dmi-plugin	DMI-Plugin Documentation	new	Toine Siebelink	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
DCAE	dcaegen2	Data Collection Analytics and Events (DCAE)	maintained	Vijay Kumar	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
DMAAP	dmaap/buscontroller	dmaap/buscontroller	maintained	Fiachra Corcoran	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
DMAAP	dmaap/datarouter	DMaaP Data Router	maintained	Fiachra Corcoran	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
DMAAP	dmaap/messagerouter/messageservice	dmaap/message router(MR)	maintained	Fiachra Corcoran	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
DOC ArchSubCom	doc	Open Network Automation Platform	maintained (doc) Architecture Update	Thomas Kulik (doc) Architecture Update	repo 'master' exists 'latest' available in RTD Architecture Update	repo branched 'branch' available in RTD release notes available
HOLMES	holmes/engine-management	Holmes	maintained	Guangrong Fu	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available (rule-management)
HOLMES	holmes/rule-management	Holmes	maintained	Guangrong Fu	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
INTEGRATION	integration	INTEGRATION	maintained	Michał Jagiełło	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
MODELING	modeling/etsicatalog	Etsicatalog Project	maintained	Yuanhong Deng	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
MODELING	modeling/modelspec	Model Specifications	maintained	Yuanhong Deng	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
MSB	msb/apigateway	MSB(Microservices Bus)	maintained	Jinquan Ni	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
MULTICLOUD	multicloud/framework	MultiCloud Architecture	maintained	Bin Yang	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
OOM	oom	OOM Documentation Repository	maintained	Sylvain Desbureaux	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
OOM	oom/offline-installer	OOM offline-installer	maintained	Sylvain Desbureaux	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes not required
OOM	oom/platform/cert-service	OOM Certification Service	maintained	Sylvain Desbureaux	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
OOF	optf/has	Optimization Framework: Homing and Allocation	maintained	krishna moorthy	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
OOF	optf/osdf	Optimization Framework: Optimization Service Design Framework (OSDF)	maintained	krishna moorthy	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
SECCom	osa	ONAP Security	maintained	Krzysztof Opasiak	repo 'master' exists 'latest' available in RTD	not applicable (always 'latest')
POLICY	policy/parent	Policy Framework Architecture	maintained	Liam Fallon	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
SDC	sdc	SDC Documentation	maintained	Michael Morris	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
SDNC	sdnc/oam	Network Controller (SDNC)	Maintained	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
SO	so	ONAP SO	Maintained	Seshu Kumar Mudiganti	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
UUI	usecase-ui	Usecase-UI(Use Case User Interface)	maintained	xu ran	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
VFC	vfc/nfvo/lcm	VF-C(Virtual Function Controller)	maintained	Yuanhong Deng	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
VNFRQTS	vnfrqts/guidelines	VNF Guidelines	maintained	Trevor Lovett	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes not required
VNFRQTS	vnfrqts/requirements	VNF or PNF Requirements Documentation	maintained	Trevor Lovett	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
VNFRQTS	vnfrqts/testcases	VNF Test Case Descriptions	maintained	Trevor Lovett	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available (link in index page missing? to be checked)
VNFRQTS	vnfrqts/usecases	VNF Provider Use Cases	maintained	Trevor Lovett	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available (link in index page missing? to be checked))
VNFSDK	vnfsdk/model	VNFSDK Documentation	Maintained	Former user (Deleted)	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD - no changes - release notes not required
VVP	vvp/documentation	VVP Documentation	maintained	steven stark	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available

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 \| 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 'latest' available in RTD Responsibility: DOC (Checkpoint)	Documentation available: RTD 'branch' o repo 'branch' exists o 'branch' available in RTD o release notes are available Responsibility: DOC (Checkpoint)
M2	M2	M2	M2	M2	M4	RC0
DMAAP	dmaap/dbcapi	DMaaP Bus Controller REST API		Fiachra Corcoran	removed from ONAP Component List
MSB	msb/discovery	MSB(Microservices Bus)	maintained	Jinquan Ni	no documentation and not referenced (see table below) Jinquan Ni The document is included in MSB(Microservices Bus)
MSB	msb/java-sdk	MSB(Microservices Bus)	maintained	Jinquan Ni	no documentation and not referenced (see table below) Jinquan Ni The document is included in MSB(Microservices Bus)
OOF	optf/cmso	Optimization Framework: Change Management Schedule Optimization		krishna moorthy	removed from ONAP Component List

Unmaintained Repositories Table

Project Name (common abbreviation of the project or subcommittee) Responsibility: DOC	Repository Name (may contain documentation to be published with the upcoming release) Responsibility: DOC	ReadTheDocs Link (link pointing to RTD 'latest' main index.rst; main title used in index.rst) Responsibility: DOC	Project Lifecycle State (ONAP Dev Wiki) Responsibility: DOC	Docs In This Repo Are Part Of The Upcoming Release Responsibility: DOC	Name of Branch Used In The Upcoming Release Responsibility: DOC	Name of Latest Available Branch Responsibility: DOC
AAF	aaf/authz	AAF - Application Authorization Framework	Unmaintained	yes	Master	Frankfurt
AAF	aaf/certservice		Unmaintained	no		Frankfurt
AAF	aaf/sms		Unmaintained	no		Frankfurt
AAI	aai/esr-gui	AAI-esr-server	Unmaintained	no		Frankfurt
AAI	aai/esr-server	AAI-esr-server	Unmaintained	no		Frankfurt
AAI	aai/event-client		Mature	no		Honolulu
APPC	appc	APPC Documentation Repository	Unmaintained	yes	Frankfurt	Frankfurt
APPC	appc/deployment	APPC Deployment Documentation	Unmaintained	yes	Frankfurt	Frankfurt
CCSDK	ccsdk/apps		Mature	no		Honolulu
CCSDK	ccsdk/dashboard		Mature	no		Honolulu
CCSDK	ccsdk/platform/blueprints		Mature	no		Master
CCSDK	ccsdk/platform/nbapi		Mature	no		Amsterdam
CCSDK	ccsdk/platform/plugins		Mature	no		Elalto
ExtAPI	externalapi/nbi	ONAP ExternalAPI / NBI		yes	Honolulu	Honolulu
INTEGRATION	integration/benchmark		Incubation	no		Casablanca
INTEGRATION	integration/devtool		Incubation	no		Casablanca
INTEGRATION	integration/simulators/pnf-simulator		Incubation	no		Frankfurt
LOGGING	logging-analytics	Logging Documentation Repository	Unmaintained	yes	Master	Elalto
LOGGING	logging-analytics/pomba/pomba-audit-common		Unmaintained	no		Elalto
MODELING	modeling/toscaparsers		Mature	no		Elalto
MSB	msb/discovery	MSB(Microservices Bus)	Incubation	no		Honolulu
MSB	msb/java-sdk	MSB(Microservices Bus)	Incubation	no
MSB	msb/swagger-sdk	MSB(Microservices Bus)	Incubation	no
MULTICLOUD	multicloud/azure		Mature	no
MULTICLOUD	multicloud/k8s		Mature	no
MUSIC	music	Music Developer Documentation	Unmaintained	yes	Frankfurt	Frankfurt
MUSIC	music/distributed-kv-store	Distributed KV store Documentation	Unmaintained	yes	Master	Beijing
oparent	oparent/cia		?	no
POLICY	policy/engine		Mature	no
PORTAL	portal	Portal	Unmaintained	yes	Guilin	Guilin
SDC	sdc/sdc-distribution-client		Mature	no
SDC	sdc/sdc-docker-base		Mature	no
SDC	sdc/sdc-tosca		Mature	no
SDC	sdc/sdc-workflow-designer		Mature	no
SO	so/		Mature	no
INTEGRATION	testsuite/pythonsdk-tests		Incubation	no
VID	vid	VID Documentation	Unmaintained	yes	Honolulu	Honolulu
VFC	vfc/nfvo/driver/vnfm/svnfm		Mature	no

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!

Browser not supported