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

  The DOC project maintains a "Master" list of the tables below in MASTER Documentation Tracking Page

  Procedure

  M2

  ...

  • 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: Pointing to RTD 'latest'!
  • Content: 'Categories' of the provided documentation.
  • 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)

  ...

  • to the upper table, if the repository is once again maintained in the target release

  ...

  M4

  1. Find JIRA task attached to M4 Epic for your project, if you haven't already done so.
  2. Update the status of the JIRA task as Done.

  RCx

  1. Find JIRA task attached to RC2 Epic for your project, if you haven't already done so.
  2. Update the status of the JIRA task as Done.
  • !

  Maintained Repositories Table

  ...

  Prefill: DOC
  Update: PROJECT

  Content

  (categories of the provided documentation)M2 Architecture, APIs and Guides AAI Documentation Documentation Architecture, APIs and Guides

  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 in git/gerrit , documentation in RTD 'latest' available )in RTD Responsibility: DOC (Checkpoint)	Documentation available: RTD 'branch' ( repo 'branch' exists in git/gerrit; documentation in RTD 'branch' available ; in RTD release notes are final)available Responsibility: DOC (Checkpoint)
  M2	M2	M2	M2	M2	M4	RC0
  AAI	aai/aai-common	AAI	Documentation Repository	Maintained	William Reehil		Architecture Release Notes Installation Developer Guide	o   repo 'master' existso   available @ RTD 'latest' available in RTD	o   repo branched 'branch' exists o   available @ in RTD 'branch' o   release notes are finalavailable
  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) Documentation Architecture Installation User Guide
  CCSDK	ccsdk/cds	Controller Design Studio Architecture and Guides		CONTROLLER DESIGN STUDIO (CDS)	Maintained	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available (CCSDK) Architecture Developer Guide Installation User Guide
  CCSDK	ccsdk/distribution	TOSCA Orchestration Plugin, Directed Graph Support		Common Controller Software Development Kit	Maintained	Dan Timoney	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available Tosca Plugins DG Support CCSDK Release Notes
  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 ( Documentation (part of CCSDK)	User Documentation
  CCSDK	ccsdk/oranCCSDK	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	user-67d6f	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	Bruno Sakoto	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 Venkatesh 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	O-RAN Support in ONAP (part of CCSDK)	Architecture Developer Guide APIs Human Interfaces Release Notes	CLI	cli	CLI Documentation	Architecture Developer Guide User Guide Installation Guide Release Notes	CPS	cps	Configuration Persistence Service	Architecture User Guide Design Guide Release Notes	DCAE	dcaegen2	DCAE Architecture and Guides	Architecture APIs User Guides Design Guide Release Notes	DMAAP	dmaap/buscontroller	Bus Controller Documentation	Architecture APIs User Guides Admin Guide Release Notes
  DMAAP	dmaap/datarouter	DMaaP Data Router		maintained	Fiachra Corcoran	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD	DMAAP	dmaap/dbcapi	Bus Controller API release notes available
  DMAAP	dmaap/messagerouter/messageserviceMessage Router Documentation	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	ONAP Master Documentation	ExtAPI	externalapi/nbi	) 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 External API Framework Documentation
  HOLMES	holmes/engine-managementHOLMES Engine Management Documentation	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-managementHOLMES Architecture and APIs	Holmes	maintained	Guangrong Fu	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD  release notes available
  INTEGRATION	integrationONAP Integration Project Documentation	INTEGRATION	maintained	Michał Jagiełło	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
  MODELING	modeling/etsicatalogONAP ETSI Runtime Catalog Documentation	Etsicatalog Project	maintained	Yuanhong Deng	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
  MODELING	modeling/modelspecONAP Model Specification	Model Specifications	maintained	Yuanhong Deng	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
  MSB	msb/apigatewayMicroservices Bus Documentation	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 Framework Architecture and Guides
  OOM	oom	ONAP Operations Manager Documentation	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 Offline-Installer
  OOM	oom/platform/cert-serviceONAP CMPv2 certification support	OOM Certification Service	maintained	Sylvain Desbureaux	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD release notes available
  OOF	optf/cmsohas	Change Management Schedule Optimization documentation	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/has	ONAP policy-driven placement optimizing service documentation
  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 documentation
  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	POLICY	policy/clamp	CLAMP Architecture and Guides	User Guide
  SDC	sdc	Service Design & Creation Documentation	SDC Documentation	maintained	Michael Morris	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD  release notes available
  SDNC	sdnc/oam	SDNC Architecture, APIs and Guides	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	SO	so	Service Orchestration Architecture, APIs and Guides
  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 Architecture, APIs and Guides
  VFC	vfc/nfvo/lcm	VF-C(Virtual Function Controller	VID	vid	)	maintained	Yuanhong Deng	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD  release notes available Virtual Infrastructure Deployment Architecture, APIs and Guides
  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) Description
  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)) Usecases
  VNFSDK	vnfsdk/modelVNF SDK Documentation and User Guides	VNFSDK Documentation	Maintained	user-67d6f	repo 'master' exists 'latest' available in RTD	repo branched 'branch' available in RTD -    no changes - release notes not required
  VVP	vvp/documentation	VNF Validation Platform 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 Project Lifecycle State (Source?) (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

  UnmaintainedUnmaintainedUnmaintainedUnmaintainedMatureUnmaintainedMatureMatureIncubationUnmaintainedMatureIncubationIncubationIncubationMatureUnmaintainedMUSIC Architecture and Guides?MatureMatureMatureIncubationMature

  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 Architecture, APIs and Guides- Application Authorization Framework	Unmaintained	yes	Master	Frankfurt
  AAF		aaf/certservice		Unmaintained	no		Frankfurt
  AAF		aaf/sms		Unmaintained	no		Frankfurt
  AAI	Unmaintained	aai/esr-gui	External System Registry GUI Documentation	yes	AAI-esr-server	Unmaintained	noMaster		Frankfurt
  AAI		aai/esr-server	External System Registry Server Documentation	yes	AAI-esr-server	Unmaintained	noMaster		Frankfurt
  AAI		aai/event-client		Mature	no		Honolulu
  APPC	Unmaintained	appc	APPC Architecture, APIs and GuidesDocumentation 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	Mature	ccsdk/platform/blueprints		Mature	no		Master
  CCSDK	Mature	ccsdk/platform/nbapi		Mature	no		Amsterdam
  CCSDK	Mature	ccsdk/platform/plugins		Mature	no		Elalto
  ExtAPI	externalapi/nbi	ONAP ExternalAPI / NBI		yes	Honolulu	Honolulu
  INTEGRATION	INTEGRATION		integration/benchmark		Incubation	no		Casablanca
  INTEGRATION	Incubation	integration/devtool		Incubation	no		Casablanca
  INTEGRATION	Incubation	integration/simulators/pnf-simulator		Incubation	no		Frankfurt
  LOGGING		logging-analytics	ONAP Centralized Logging Documentation Repository	Unmaintained	yes	Master	Elalto
  LOGGING	Unmaintained	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	Mature	multicloud/k8s		Mature	no
  MUSIC	music	music	Music Developer Documentation	Unmaintained	yes	Frankfurt	Frankfurt
  MUSIC	Unmaintained	music/distributed-kv-storeMUSIC Distribute KV Store Documents	Distributed KV store Documentation	Unmaintained	yes	Master	Beijing
  oparent		oparent/cia		?	no
  POLICY	Mature	policy/engine		Mature	no
  PORTAL	Unmaintained	portal	ONAP Portal Platform Documentation	Unmaintained	yes	Guilin	Guilin
  SDC		sdc/sdc-distribution-client		Mature	no
  SDC	Mature	sdc/sdc-docker-base		Mature	no
  SDC	Mature	sdc/sdc-tosca		Mature	no
  SDC		sdc/sdc-workflow-designer		Mature	no
  SO		so/libs		Mature	no
  INTEGRATION		testsuite/pythonsdk-tests		Incubation	no
  VID	vid	VID Documentation	Unmaintained	yes	Honolulu	Honolulu
  VFC	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!