Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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

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

  •  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

  • 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

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   available @ RTD 'latest'

Responsibility:
DOC (Checkpoint)
#

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 and updated

Responsibility:
DOC (Checkpoint)


M2M2M2M2M2M4RC0
01AAIaai/aai-commonAAI Documentation RepositoryMinor changes for Jakarta

(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

02AAIaai/sparky-beSparky - Inventory UI Service

Repo status: No change

Doc status: No change

(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 (aai/aai-common)

03CCSDKccsdk/appsCCSDK APPS DOCUMENTATION REPOSITORY

Repo status: No change

Doc status: No change

(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)Changes expected for Jakarta

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

05CCSDKccsdk/distributionCommon Controller Software Development KitChanges expected for Jakarta

(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 helpChanges expected for Jakarta

(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/oranChanges expected for Jakarta

(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

Repo status: No change

Doc status: No change

(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

09CPScpsCPS Documentation

(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 Temporal

(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

11CPScps/ncmp-dmi-pluginDMI-Plugin Documentation

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

(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) 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) 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) 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) repo 'master' exists

(tick) 'latest' available in RTD



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

(tick) Architecture updated

17HOLMESholmes/engine-managementHolmes

Installation update due to

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyHOLMES-488

(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-managementHolmes

Installation update due to

Jira
serverONAP Jira
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyHOLMES-488

(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

(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 ProjectMinor changes expected for Jakarta

(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

21MODELINGmodeling/modelspecModel Specifications

(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

22MSBmsb/apigatewayMSB(Microservices Bus)

Changes expected for Jakarta

(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/discoveryMSB(Microservices Bus)

maintained

Minor changes expected for Jakarta

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

24MSBmsb/java-sdkMSB(Microservices Bus)

maintained

Minor changes expected for Jakarta

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

25MSBmsb/swagger-sdkSwagger SDK

Repo status: No change

Doc status: No change

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

26

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

Documentation available:
RTD 'branch'

o   repo 'branch' exists
o   available @ RTD 'branch'
o   release notes are final

Responsibility:
DOC (Checkpoint)

M2M2M2M2M2M4RC0
AAIaai/aai-commonAAI Documentation RepositoryMaintainedWilliam ReehilAAIaai/sparky-beSparky - Inventory UI ServiceMaintainedWilliam ReehilCCSDKccsdk/cdsCONTROLLER DESIGN STUDIO (CDS)MaintainedDan TimoneyCCSDKccsdk/distributionCommon Controller Software Development KitMaintainedDan TimoneyCCSDKccsdk/featuresSDN-R Online helpMaintainedDan TimoneyCCSDKccsdk/oranccsdk/oranMaintainedDan TimoneyCLIcliONAP CLIMaintainedCPScpsCPS DocumentationCPScps/cps-tbdmtCPS DocumentationnewCPScps/cps-temporalCPS DocumentationnewCPScps/ncmp-dmi-pluginCPS DocumentationnewToine SiebelinkDCAEdcaegen2Data Collection Analytics and Events (DCAE)maintainedDMAAPdmaap/buscontrollerdmaap/buscontrollermaintainedDMAAPdmaap/datarouterDMaaP Data RoutermaintainedDMAAPdmaap/dbcapiDMaaP Bus Controller REST APIremoveDMAAPdmaap/messagerouter/messageservicedmaap/message router(MR)maintained

DOC

ArchSubCom

docOpen Network Automation PlatformExtAPIexternalapi/nbiONAP ExternalAPI / NBIHOLMESholmes/engine-managementHolmesmaintainedGuangrong FuHOLMESholmes/rule-managementHolmesmaintainedINTEGRATIONintegrationINTEGRATIONMODELINGmodeling/etsicatalogEtsicatalog ProjectmaintainedYuanhong DengMODELINGmodeling/modelspecModel SpecificationsMSBmsb/apigatewayMSB(Microservices Bus)maintainedJinquan NiMSBmsb/discoveryMSB(Microservices Bus)maintainedMSBmsb/java-sdkMSB(Microservices Bus)maintainedJinquan NiMULTICLOUDmulticloud/frameworkMultiCloud ArchitecturemaintainedBin YangOOMoomOOM Documentation RepositoryOOMoom/offline-installerOOM offline-installerOOMoom/platform/cert-serviceOOM Certification ServiceOOFoptf/cmsoOptimization Framework: Change Management Schedule Optimizationremovekrishna moorthyOOFoptf/hasOptimization Framework: Homing and AllocationmaintainedOOFoptf/osdfOptimization Framework: Optimization Service Design Framework (OSDF)maintainedkrishna moorthySECComosaONAP SecurityPOLICYpolicy/parentPolicy Framework ArchitecturemaintainedSDCsdcSDC DocumentationmaintainedMichael MorrisSDNCsdnc/oamNetwork Controller (SDNC)MaintainedDan TimoneySOsoONAP SOMaintainedSeshu Kumar MudigantiUUIusecase-uiUsecase-UI(Use Case User Interface)maintainedxu ranVFCvfc/nfvo/lcmVF-C(Virtual Function Controller)maintainedYuanhong DengVIDvidVID DocumentationVNFRQTSvnfrqts/guidelinesVNF GuidelinesmaintainedVNFRQTSvnfrqts/requirementsVNF or PNF Requirements DocumentationmaintainedVNFRQTSvnfrqts/testcasesVNF Test Case DescriptionsmaintainedVNFRQTSvnfrqts/usecasesVNF Provider Use CasesmaintainedVNFSDKvnfsdk/modelVNFSDK DocumentationMaintaineduser-67d6fVVPvvp/documentationVVP Documentationmaintained

Unmaintained Repositories Table

Repo status: No change

Doc status: No change

(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

27MULTICLOUDmulticloud/k8sMultiCloud Kubernetes PluginMinor changes expected for Jakarta

(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 (multicloud/framework)

28OOMoomOOM Documentation Repository
no PTL since 2022-04-01

(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

29OOMoom/offline-installerOOM offline-installer

Repo status: No change

Doc status: No change

no PTL since 2022-04-01

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

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

30OOMoom/platform/cert-serviceOOM Certification Service

no PTL since 2022-04-01

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

31OOFoptf/hasOptimization Framework: Homing and AllocationChanges expected for Jakarta

(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

32OOFoptf/osdfOptimization Framework: Optimization Service Design Framework (OSDF)Changes expected for Jakarta

(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

33SECComosaONAP Security

(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

34POLICYpolicy/parentPolicy Framework ArchitectureChanges expected for Jakarta

(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

35SDCsdcSDC DocumentationMinor changes for Jakarta

(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

36SDNCsdnc/oamNetwork Controller (SDNC)Changes expected for Jakarta

(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

37SOsoONAP SOMinor changes expected for Jakarta

(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

38UUIusecase-uiUsecase-UI(Use Case User Interface)Minor changes expected for Jakarta

(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

39VFCvfc/nfvo/lcmVF-C(Virtual Function Controller)Minor changes expected for Jakarta

(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

40VNFSDKvnfsdk/modelVNFSDK Documentation

Repo status: No change

Doc status: No change

(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

Non-Relevant Repositories Table

Repository Name

(may contain documentation to be published with the upcoming release)

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
#

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
01VNFRQTSvnfrqts/guidelinesVNF Guidelinesunmaintained

no PTL since 2021-11-01

(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 ((question)vnfrqts/requirements)

02VNFRQTSvnfrqts/requirementsVNF or PNF Requirements Documentationunmaintained

no PTL since 2021-11-01

(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

03VNFRQTSvnfrqts/testcasesVNF Test Case Descriptionsunmaintained

no PTL since 2021-11-01

(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

04VNFRQTSvnfrqts/usecasesVNF Provider Use Casesunmaintained

no PTL since 2021-11-01

(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

05VVPvvp/documentationVVP Documentationunmaintained

(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

Project Name

(common abbreviation of the project or subcommittee)

Responsibility:
DOC

ReadTheDocs Link

(link pointing to RTD 'latest' main index.rst; main title used in index.rst)

Responsibility:
DOC

AAFaaf/authzAAF - Application Authorization FrameworkUnmaintainedyesMasterFrankfurt
AAFaaf/certserviceUnmaintainednoFrankfurtAAFaaf/smsUnmaintainednoFrankfurt
AAIaai/esr-guiAAI-esr-serverUnmaintainedyesMasterFrankfurt
AAIaai/esr-serverAAI-esr-serverUnmaintainedyesMasterFrankfurt
AAIaai/event-clientMaturenoHonolulu
APPCappcAPPC Documentation RepositoryUnmaintainedyesFrankfurtFrankfurt
APPCappc/deploymentAPPC Deployment DocumentationUnmaintainedyesFrankfurtFrankfurt
CCSDKccsdk/appsMaturenoHonoluluCCSDKccsdk/dashboardMaturenoHonoluluCCSDKccsdk/platform/blueprintsMaturenoMasterCCSDKccsdk/platform/nbapiMaturenoAmsterdamCCSDKccsdk/platform/pluginsMaturenoElaltoINTEGRATIONintegration/benchmarkIncubationnoCasablancaINTEGRATIONintegration/devtoolIncubationnoCasablancaINTEGRATIONintegration/simulators/pnf-simulatorIncubationnoFrankfurt
LOGGINGlogging-analyticsLogging Documentation RepositoryUnmaintainedyesMasterElalto
LOGGINGlogging-analytics/pomba/pomba-audit-commonUnmaintainednoElaltoMODELINGmodeling/toscaparsersMaturenoElaltoMSBmsb/discoveryIncubationnoHonoluluMSBmsb/java-sdkIncubationnoMSBmsb/swagger-sdkIncubationnoMULTICLOUDmulticloud/azureMaturenoMULTICLOUDmulticloud/k8sMatureno
MUSICmusicMusic Developer DocumentationUnmaintainedyesFrankfurtFrankfurt
MUSICmusic/distributed-kv-storeDistributed KV store DocumentationUnmaintainedyesMasterBeijing
oparentoparent/cia?noPOLICYpolicy/engineMatureno
PORTALportalPortalUnmaintainedyesGuilinGuilin
SDCsdc/sdc-distribution-clientMaturenoSDCsdc/sdc-docker-baseMaturenoSDCsdc/sdc-toscaMaturenoSDCsdc/sdc-workflow-designerMaturenoSOso/MaturenoINTEGRATIONtestsuite/pythonsdk-testsIncubationnoVFCvfc/nfvo/driver/vnfm/svnfmMatureno










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:

...

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 November 2021) an ONAP release deployed via OOM consists of components whose underlying repositories include documentation and where the repositories ...

...

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!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:

...

Repository Status: Please note if the repository is new, was maintained has changed or must be removed.  For 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!