Table of Contents

Short Explanation

Maintained Repositories

...

• Containing documentation repositories for the upcoming release

...

• Maintained 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 belnging to an unmaintained project, but used in the ONAP documentation

  ...

  •  Could be "reactivated" by the ONAP project in the upcoming release
  •  

  ...

  • Maintained mainly by DOC, but PROJECTS are asked to check if status of repository has changed

  Maintained Repositories Table

  Project Name (common abbreviation of the project or subcommittee) Prefill: DOC Update: PROJECT	Repository Name (contains documentation to be published with the upcoming release) Prefill: DOC Update: PROJECT	ReadTheDocs Link (pointing to RTD 'latest') Prefill: DOC Update: PROJECT	Content (categories of the provided documentation) Prefill: DOC Update: PROJECT	Repository Status (new | maintained | remove ; needed to e.g. identify changes in the intersphinx linking) PROJECT	Documentation Owner(s) (responsible for documentation in this repo; please use @ notation for the name) PROJECT	Documentation available: RTD 'latest' (repo 'master' exists in git/gerrit , documentation in RTD 'latest' available) DOC (Checkpoint)	Documentation available: RTD 'branch' (repo 'branch' exists in git/gerrit; documentation in RTD 'branch' available; release notes are final) DOC (Checkpoint)
  M2	M2	M2	M2	M2	M2	M4	RC0
  AAI	aai/aai-common	AAI Architecture, APIs and Guides	Architecture Release Notes Installation Developer Guide			o   repo 'master' exists o   available @ RTD 'latest'	o   repo 'branch' exists o   available @ RTD 'branch' o   release notes are final
  AAI	aai/sparky-be	Sparky - AAI Inventory UI Documentation	Architecture Installation User Guide
  CCSDK	ccsdk/cds	Controller Design Studio Architecture and Guides	Architecture Developer Guide Installation User Guide
  CCSDK	ccsdk/distribution	TOSCA Orchestration Plugin, Directed Graph Support	Tosca Plugins DG Support CCSDK Release Notes
  CCSDK	ccsdk/features	SDN-R Documentation (part of CCSDK)	User Documentation
  CCSDK	ccsdk/oran	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	Data Router Documentation
  DMAAP	dmaap/dbcapi	Bus Controller API
  DMAAP	dmaap/messagerouter/messageservice	Message Router Documentation
  DOC ArchSubCom	doc	ONAP Master Documentation
  ExtAPI	externalapi/nbi	External API Framework Documentation
  HOLMES	holmes/engine-management	HOLMES Engine Management Documentation
  HOLMES	holmes/rule-management	HOLMES Architecture and APIs
  INTEGRATION	integration	ONAP Integration Project Documentation
  MODELING	modeling/etsicatalog	ONAP ETSI Runtime Catalog Documentation
  MODELING	modeling/modelspec	ONAP Model Specification
  MSB	msb/apigateway	Microservices Bus Documentation
  MULTICLOUD	multicloud/framework	MultiCloud Framework Architecture and Guides
  OOM	oom	ONAP Operations Manager Documentation
  OOM	oom/offline-installer	OOM Offline-Installer
  OOM	oom/platform/cert-service	ONAP CMPv2 certification support
  OOF	optf/cmso	Change Management Schedule Optimization documentation
  OOF	optf/has	ONAP policy-driven placement optimizing service documentation
  OOF	optf/osdf	Optimization Service Design Framework documentation
  SECCom	osa	ONAP Security
  POLICY	policy/parent	Policy Framework Documentation
  POLICY	policy/clamp	CLAMP Architecture and Guides	User Guide
  SDC	sdc	Service Design & Creation Documentation
  SDNC	sdnc/oam	SDNC Architecture, APIs and Guides
  SO	so	Service Orchestration Architecture, APIs and Guides
  UUI	usecase-ui	Usecase-UI Architecture, APIs and Guides
  VFC	vfc/nfvo/lcm	Virtual Function Controller Architecture, APIs and Guides
  VID	vid	Virtual Infrastructure Deployment Architecture, APIs and Guides
  VNFRQTS	vnfrqts/guidelines	VNF Guidelines
  VNFRQTS	vnfrqts/requirements	VNF or PNF Requirements Documentation
  VNFRQTS	vnfrqts/testcases	VNF Test Case Description
  VNFRQTS	vnfrqts/usecases	VNF Provider Usecases
  VNFSDK	vnfsdk/model	VNF SDK Documentation and User Guides
  VVP	vvp/documentation	VNF Validation Platform Documentation

  
  

  Unmaintained Repositories Table

  Project Name (common abbreviation of the project or subcommittee) DOC	Project Lifecycle State (Source?) DOC	Repository Name (may contain documentation to be published with the upcoming release) DOC	ReadTheDocs Link (pointing to RTD latest) DOC	Docs In This Repo Are Part Of The Upcoming Release DOC	Branch Used In The Upcoming Release DOC	Latest Available Branch DOC
  AAF	Unmaintained	aaf/authz	AAF Architecture, APIs and Guides	yes	Master	Frankfurt
  AAF	Unmaintained	aaf/certservice		no		Frankfurt
  AAF	Unmaintained	aaf/sms		no		Frankfurt
  AAI	Unmaintained	aai/esr-gui	External System Registry GUI Documentation	yes	Master	Frankfurt
  AAI	Unmaintained	aai/esr-server	External System Registry Server Documentation	yes	Master	Frankfurt
  AAI	Mature	aai/event-client		no		Honolulu
  APPC	Unmaintained	appc	APPC Architecture, APIs and Guides	yes	Frankfurt	Frankfurt
  APPC	Unmaintained	appc/deployment	APPC Deployment Documentation	yes	Frankfurt	Frankfurt
  CCSDK	Mature	ccsdk/apps		no		Honolulu
  CCSDK	Mature	ccsdk/dashboard		no		Honolulu
  CCSDK	Mature	ccsdk/platform/blueprints		no		Master
  CCSDK	Mature	ccsdk/platform/nbapi		no		Amsterdam
  CCSDK	Mature	ccsdk/platform/plugins		no		Elalto
  INTEGRATION	Incubation	integration/benchmark		no		Casablanca
  INTEGRATION	Incubation	integration/devtool		no		Casablanca
  INTEGRATION	Incubation	integration/simulators/pnf-simulator		no		Frankfurt
  LOGGING	Unmaintained	logging-analytics	ONAP Centralized Logging Documentation	yes	Master	Elalto
  LOGGING	Unmaintained	logging-analytics/pomba/pomba-audit-common		no		Elalto
  MODELING	Mature	modeling/toscaparsers		no		Elalto
  MSB	Incubation	msb/discovery		no		Honolulu
  MSB	Incubation	msb/java-sdk		no
  MSB	Incubation	msb/swagger-sdk		no
  MULTICLOUD	Mature	multicloud/azure		no
  MULTICLOUD	Mature	multicloud/k8s		no
  MUSIC	Unmaintained	music	MUSIC Architecture and Guides	yes	Frankfurt	Frankfurt
  MUSIC	Unmaintained	music/distributed-kv-store	MUSIC Distribute KV Store Documents	yes	Master	Beijing
  oparent	?	oparent/cia		no
  POLICY	Mature	policy/engine		no
  PORTAL	Unmaintained	portal	ONAP Portal Platform Documentation	yes	Guilin	Guilin
  SDC	Mature	sdc/sdc-distribution-client		no
  SDC	Mature	sdc/sdc-docker-base		no
  SDC	Mature	sdc/sdc-tosca		no
  SDC	Mature	sdc/sdc-workflow-designer		no
  SO	Mature	so/libs		no
  INTEGRATION	Incubation	testsuite/pythonsdk-tests		no
  VFC	Mature	vfc/nfvo/driver/vnfm/svnfm		no

  ...