London Documentation

IMPORTANT NOTE

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

  • create a branch for the new release
  • be actively maintained or have a TSC exception

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)

( see also History of PTL )

Responsibility:
PROJECT

Documentation available:
RTD 'latest'

(relevant for new repos which are participating the first time)

(question)(error)(tick) docs config up-to-date
(question)(error)(tick) repo 'master' exists
(question)(error)(tick) 'latest' available in RTD

Responsibility:
DOC (Checkpoint)

Documentation available:
RTD 'branch'

(question)(error)(tick) repo 'branch' exists
(question)(error)(tick) 'branch' available in RTD
(question)(error)(tick) release notes available in RTD and updated

Responsibility:
DOC (Checkpoint)


M2M2M2M2M2M4RC0
01AAIaai/aai-commonAAI Documentation Repository

no PTL since 2022-12-02

(question) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available in RTD and updated

02AAIaai/sparky-beSparky - Inventory UI Service


no PTL since 2022-12-02

(question) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available in RTD and updated (aai/aai-common)

03CCSDKccsdk/appsCCSDK APPS DOCUMENTATION REPOSITORY

no updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated (ccsdk/distribution)

04CCSDKccsdk/cdsCONTROLLER DESIGN STUDIO (CDS)changed

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available in RTD and updated (ccsdk/distribution) 

05CCSDKccsdk/distributionCommon Controller Software Development Kitchanged

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated

06CCSDKccsdk/featuresSDN-R Online helpchanged

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated (ccsdk/distribution)

07CCSDKccsdk/oranccsdk/oranchanged

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated

08CLIcliONAP CLI


(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available in RTD and updated

09CPScpsCPS Documentationno updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated

10CPScps/cps-temporalCPS Temporalno updates

LEILA NISHIMWE  

According to Toine Siebelink the project is no longer maintained. To be removed?

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available in RTD and updated

11CPScps/ncmp-dmi-pluginDMI-Plugin Documentationno updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated

12DCAEdcaegen2Data Collection Analytics and Events (DCAE)DCAE Mod retired (no change in root documentation repo)

no PTL since 2022-12-01

(question) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick)  release notes available in RTD and updated

13DMAAPdmaap/buscontrollerdmaap/buscontroller

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick)  release notes available in RTD and updated

14DMAAPdmaap/datarouterDMaaP Data Router

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick)  release notes available in RTD and updated

15DMAAPdmaap/messagerouter/messageservicedmaap/message router(MR)

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick)  release notes available in RTD and updated

16

DOC




ArchSubCom

doc

Open Network Automation Platform




ONAP Architecture





Architecture Updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD


(question) Architecture updated

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes (doc) available in RTD and updated

(tick) release notes (composite) available in RTD and updated

(error) Architecture updated

17HOLMESholmes/engine-managementHolmes

no updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated (holmes/rule-management)

18HOLMESholmes/rule-managementHolmesno updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated

19INTEGRATIONintegrationINTEGRATION
no PTL since 2022-06-30

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated

20MODELINGmodeling/etsicatalogEtsicatalog Project

no updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick)  repo branched

(tick) 'branch' available in RTD

(question) release notes available in RTD and updated

21MODELINGmodeling/modelspecModel Specificationsno updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

'branch' available in RTD

release notes available in RTD and updated

22MSBmsb/apigatewayMSB(Microservices Bus)

no updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated

23MSBmsb/swagger-sdkSwagger SDK

no updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated (msb/apigateway)

24MULTICLOUDmulticloud/frameworkMultiCloud Architecture


Bin Yang

stepping down as PTL 2023-04-24

(question) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available in RTD and updated

25MULTICLOUDmulticloud/k8sMultiCloud Kubernetes Plugin

Bin Yang

stepping down as PTL 2023-04-24

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available in RTD and updated (multicloud/framework)

26OOMoomOOM Documentation Repositorychanged: will be updated to reflect the London changes (ServiceMesh, AAF removal, Ingress)no PTL since 2022-04-01

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated

27OOFoptf/hasOptimization Framework: Homing and Allocation

no PTL since 2022-10-07

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available in RTD and updated

28OOFoptf/osdfOptimization Framework: Optimization Service Design Framework (OSDF)
no PTL since 2022-10-07

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available in RTD and updated

29POLICYpolicy/parentPolicy Framework ArchitectureNo updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated

30Portal-NGportal-ngPortal-NGPOC - currently no docs availableGeorg Schweflinghaus 

(question) docs config up-to-date

(question) repo 'master' exists

(question) 'latest' available in RTD

(question) repo branched

(question) 'branch' available in RTD

(question) release notes available in RTD and updated

31SECComosaONAP Security

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available in RTD and updated

32SDCsdcSDC Documentation

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated

33SDNCsdnc/oamNetwork Controller (SDNC)changed

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated

34SOsoONAP SO

General platform update 

Architecture 

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available in RTD and update

35UUIusecase-uiUsecase-UI(Use Case User Interface)

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick)repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated

36VFCvfc/nfvo/lcmVF-C(Virtual Function Controller)


no PTL since 22-12-05

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available in RTD and updated

37VNFSDKvnfsdk/modelVNFSDK Documentation


(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) 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)

(question)(error)(tick) repo 'master' exists
(question)(error)(tick) 'latest' available in RTD

Responsibility:
DOC (Checkpoint)

Documentation available:
RTD 'branch'

(question)(error)(tick) repo 'branch' exists
(question)(error)(tick) 'branch' available in RTD
(question)(error)(tick) release notes available in RTD

Responsibility:
DOC (Checkpoint)


M2M2M2M2M2M4RC0
01OOMoom/offline-installerOOM offline-installer

remove: not maintained anymore

no PTL since 2022-04-01

(question) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(error) repo branched

(error) 'branch' available in RTD

(error) release notes (ChangeLog) available in RTD and updated

02OOMoom/platform/cert-serviceOOM Certification Serviceremove: will not be needed, as AAF will be removed

no PTL since 2022-04-01

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(error) repo branched

(error) 'branch' available in RTD

(error) release notes available in RTD and updated

03MSBmsb/discoveryMSB(Microservices Bus)

no updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated (msb/apigateway)

04MSBmsb/java-sdkMSB(Microservices Bus)

no updates

(tick) docs config up-to-date

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available in RTD and updated (msb/apigateway)

00






00






00






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)