Versions Compared

Key

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

...

  • 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

...

Architecture, APIs and Guides AAI Documentation

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)

PrefillResponsibility: DOC
Update: PROJECT

ReadTheDocs Link

(pointing to RTD 'latest')

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'

((error)(tick) repo 'master' exists in git/gerrit , documentation in RTD 'latest' available)
(error)(tick) 'latest' available in RTD


Responsibility:
DOC (Checkpoint)

Documentation available:
RTD 'branch'

((error)(tick) repo 'branch' exists in git/gerrit; documentation in RTD
(error)(tick) 'branch' available ; in RTD
(error)(tick) release notes are final)available

Responsibility:
DOC (Checkpoint)

M2M2M2M2M2M4RC0
AAIaai/aai-commonAAI AAI Documentation RepositoryMaintainedWilliam Reehil

o   (tick) repo 'master' existso   available @ RTD

(tick) 'latest' available in RTD

o   (tick) repo branched

(tick) 'branch' exists
o   available @ in RTD 'branch'

o   (tick) release notes are finalavailable

AAIaai/sparky-beSparky - Inventory UI Sparky - Inventory UI ServiceCCSDKccsdk/cdsController Design Studio Architecture and GuidesCONTROLLER DESIGN STUDIO (CDS)MaintainedWilliam Reehil

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available (AAI common)

CCSDKccsdk/cdsCONTROLLER DESIGN STUDIO (CDS)MaintainedDan Timoney

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available (CCSDK)

CCSDKccsdk/distributionCommon Controller Software Development KitMaintainedDan Timoney

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

CCSDKccsdk/featuresSDN-R Online helpMaintainedDan Timoney

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available (CCSDK)

CCSDKccsdk/oranccsdk/oranMaintainedDan Timoney

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available (CCSDK)

CLIcliONAP CLIMaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

-    no changes - release notes not required

CPScpsCPS Documentation

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

CPScps/cps-temporalCPS Temporalnew

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

CPScps/ncmp-dmi-pluginDMI-Plugin DocumentationnewToine Siebelink

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

DCAEdcaegen2Data Collection Analytics and Events (DCAE)maintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

DMAAPdmaap/buscontrollerdmaap/buscontrollermaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

DMAAPdmaap/datarouterDMaaP Data Routermaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

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

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

DOC


(question) ArchSubCom

docOpen Network Automation Platform

maintained (doc)


(question) Architecture Update

Thomas Kulik (doc)


(question) Architecture Update

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(question) Architecture Update

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

HOLMESholmes/engine-managementHolmesmaintainedGuangrong Fu

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available (rule-management)

HOLMESholmes/rule-managementHolmesmaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

INTEGRATIONintegrationINTEGRATIONmaintainedMichał Jagiełło 

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

MODELINGmodeling/etsicatalogEtsicatalog ProjectmaintainedYuanhong Deng

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

MODELINGmodeling/modelspecModel SpecificationsmaintainedYuanhong Deng 

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

MSBmsb/apigatewayMSB(Microservices Bus)maintainedJinquan Ni

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

MULTICLOUDmulticloud/frameworkMultiCloud ArchitecturemaintainedBin Yang

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

OOMoomOOM Documentation RepositorymaintainedSylvain Desbureaux 

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

OOMoom/offline-installerOOM offline-installermaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes not required

OOMoom/platform/cert-serviceOOM Certification Servicemaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

OOFoptf/hasOptimization Framework: Homing and Allocationmaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

OOFoptf/osdfOptimization Framework: Optimization Service Design Framework (OSDF)maintainedkrishna moorthy

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

SECComosaONAP SecuritymaintainedKrzysztof Opasiak 

(tick) repo 'master' exists

(tick) 'latest' available in RTD

not applicable (always 'latest')
POLICYpolicy/parentPolicy Framework ArchitecturemaintainedLiam Fallon 

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

SDCsdcSDC DocumentationmaintainedMichael Morris

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

SDNCsdnc/oamNetwork Controller (SDNC)MaintainedDan Timoney

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

SOsoONAP SOMaintainedSeshu Kumar Mudiganti

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

UUIusecase-uiUsecase-UI(Use Case User Interface)maintainedxu ran

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

VFCvfc/nfvo/lcmVF-C(Virtual Function Controller)maintainedYuanhong Deng

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

VNFRQTSvnfrqts/guidelinesVNF Guidelinesmaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes not required

VNFRQTSvnfrqts/requirementsVNF or PNF Requirements Documentationmaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

VNFRQTSvnfrqts/testcasesVNF Test Case Descriptionsmaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available
(link in index page missing? to be checked)

VNFRQTSvnfrqts/usecasesVNF Provider Use Casesmaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(error) release notes available
(link in index page missing? to be checked))

VNFSDKvnfsdk/modelVNFSDK DocumentationMaintaineduser-67d6f

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

-    no changes - release notes not required

VVPvvp/documentationVVP Documentationmaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

Non-Relevant Repositories Table

o   repo 'master' exists in gerrit
o   available @ RTD 'latest in gerrit available @ RTD final

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

CCSDKccsdk/distributionTOSCA Orchestration Plugin, Directed Graph SupportCommon Controller Software Development KitCCSDKccsdk/featuresSDN-R Documentation (part of CCSDK)SDN-R Online helpCCSDKccsdk/oranO-RAN Support in ONAP (part of CCSDK)ccsdk/oranCLIcliCLI DocumentationONAP CLICPScpsConfiguration Persistence ServiceCPS Documentation for the Honolulu-R8 ReleaseCPScps/cps-tbdmtTBD<add_title>newCPScps/cps-temporalTBD<add_title>newCPScps/ncmp-dmi-pluginTBD<add_title>newToine SiebelinkDCAEdcaegen2DCAE Architecture and GuidesData Collection Analytics and Events (DCAE)DMAAPdmaap/buscontrollerBus Controller Documentationdmaap/buscontrollerDMAAPdmaap/datarouterData Router DocumentationDMaaP Data RouterDMAAPdmaap/dbcapiBus Controller APIDMaaP Bus Controller REST APIDMAAPdmaap/messagerouter/messageserviceMessage Router Documentationdmaap/message router(MR)

DOC

ArchSubCom

docONAP Master DocumentationOpen Network Automation PlatformExtAPIexternalapi/nbiExternal API Framework DocumentationONAP ExternalAPI / NBIHOLMESholmes/engine-managementHOLMES Engine Management DocumentationHolmesmaintainedGuangrong FuHOLMESholmes/rule-managementHOLMES Architecture and APIsHolmesmaintainedINTEGRATIONintegrationONAP Integration Project DocumentationINTEGRATIONMODELINGmodeling/etsicatalogONAP ETSI Runtime Catalog DocumentationEtsicatalog ProjectmaintainedYuanhong DengMODELINGmodeling/modelspecONAP Model SpecificationModel SpecificationsMSBmsb/apigatewayMicroservices Bus DocumentationMSB(Microservices Bus)MULTICLOUDmulticloud/frameworkMultiCloud Framework Architecture and GuidesMultiCloud ArchitecturemaintainedBin YangOOMoomONAP Operations Manager DocumentationOOM Documentation RepositoryOOMoom/offline-installerOOM Offline-InstallerOOM offline-installerOOMoom/platform/cert-serviceONAP CMPv2 certification supportOOM Certification ServiceOOFoptf/cmsoChange Management Schedule Optimization documentationOptimization Framework: Change Management Schedule Optimizationremovekrishna moorthyOOFoptf/hasONAP policy-driven placement optimizing service documentationOptimization Framework: Homing and Allocationmaintainedo   repo 'master' exists
o   available @ RTD 'latest'
OOFoptf/osdfOptimization Service Design Framework documentationOptimization Framework: Optimization Service Design Framework (OSDF)maintainedkrishna moorthyo   repo 'master' exists
o   available @ RTD 'latest'
SECComosaONAP SecurityONAP SecurityPOLICYpolicy/parentPolicy Framework DocumentationPolicy Framework Architecturemaintainedo   repo 'master' exists
o   available @ RTD 'latest'
SDCsdcService Design & Creation DocumentationSDC DocumentationmaintainedMichael MorrisSDNCsdnc/oamSDNC Architecture, APIs and GuidesNetwork Controller (SDNC)SOsoService Orchestration Architecture, APIs and GuidesONAP SOUUIusecase-uiUsecase-UI Architecture, APIs and GuidesUsecase-UI(Use Case User Interface)maintainedxu ran

'

o   repo 'branch' exists


o  

'branch' available in RTD
o   release notes are

available

Responsibility:
DOC (Checkpoint)

M2M2M2M2M2M4RC0
DMAAPdmaap/dbcapiDMaaP Bus Controller REST API
removed from ONAP Component List
MSBmsb/discoveryMSB(Microservices Bus)maintained

no documentation and not referenced (see table below)


Jinquan Ni The document is included in MSB(Microservices Bus)


MSBmsb/java-sdkMSB(Microservices Bus)maintainedJinquan Ni

no documentation and not referenced (see table below)


Jinquan Ni The document is included in MSB(Microservices Bus)


OOFoptf/cmsoOptimization Framework: Change Management Schedule Optimization
removed from ONAP Component ListVFCvfc/nfvo/lcmVirtual Function Controller Architecture, APIs and GuidesVF-C(Virtual Function Controller)maintainedYuanhong DengVIDvidVirtual Infrastructure Deployment Architecture, APIs and GuidesVNFRQTSvnfrqts/guidelinesVNF GuidelinesVNFRQTSvnfrqts/requirementsVNF or PNF Requirements DocumentationVNFRQTSvnfrqts/testcasesVNF Test Case DescriptionVNFRQTSvnfrqts/usecasesVNF Provider UsecasesVNFSDKvnfsdk/modelVNF SDK Documentation and User GuidesVVPvvp/documentationVNF Validation Platform Documentationmaintainedsteven stark


Unmaintained Repositories Table

Project Lifecycle State

(Source?)

UnmaintainedUnmaintainedMatureUnmaintainedUnmaintainedMatureMatureElaltoIncubationIncubationMatureIncubationMatureMatureUnmaintainedMUSIC Architecture and Guides?UnmaintainedMatureMatureMatureMatureMatureIncubation

Project Name

(common abbreviation of the project or subcommittee)

DOC

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

AAFUnmaintainedaaf/authzAAF Architecture, APIs and Guides- Application Authorization FrameworkUnmaintainedyesMasterFrankfurt
AAFaaf/certservice
Unmaintainedno
Frankfurt
AAFUnmaintainedaaf/sms
Unmaintainedno
Frankfurt
AAIaai/esr-guiExternal System Registry GUI DocumentationyesAAI-esr-serverUnmaintainednoMaster
Frankfurt
AAIUnmaintainedaai/esr-serverExternal System Registry Server DocumentationyesAAI-esr-serverUnmaintainednoMaster
Frankfurt
AAIaai/event-client
Matureno
Honolulu
APPCappcAPPC Architecture, APIs and GuidesDocumentation RepositoryUnmaintainedyesFrankfurtFrankfurt
APPCappc/deploymentAPPC Deployment DocumentationUnmaintainedyesFrankfurtFrankfurt
CCSDKccsdk/apps
Matureno
Honolulu
CCSDKMatureccsdk/dashboard
Matureno
Honolulu
CCSDKccsdk/platform/blueprints
Matureno
Master
CCSDKMatureccsdk/platform/nbapi
Matureno
Amsterdam
CCSDKccsdk/platform/plugins
Matureccsdk/platform/pluginsnono
Elalto
ExtAPIexternalapi/nbiONAP ExternalAPI / NBI
yesHonoluluHonolulu
INTEGRATIONIncubationintegration/benchmark
Incubationno
Casablanca
INTEGRATIONintegration/devtool
Incubationno
Casablanca
INTEGRATIONintegration/simulators/pnf-simulator
Incubationno
Frankfurt
LOGGINGUnmaintainedlogging-analyticsONAP Centralized Logging Documentation RepositoryUnmaintainedyesMasterElalto
LOGGINGUnmaintainedlogging-analytics/pomba/pomba-audit-common
Unmaintainedno
Elalto
MODELINGmodeling/toscaparsers
Matureno
Elalto
MSBIncubationmsb/discoveryMSB(Microservices Bus)Incubationno
Honolulu
MSBIncubationmsb/java-sdkMSB(Microservices Bus)Incubationno

MSBmsb/swagger-sdkMSB(Microservices Bus)Incubationno

MULTICLOUDmulticloud/azure
Matureno

MULTICLOUDmulticloud/k8s
Matureno

MUSICmusicmusicMusic Developer DocumentationUnmaintainedyesFrankfurtFrankfurt
MUSICUnmaintainedmusic/distributed-kv-storeMUSIC Distribute KV Store DocumentsDistributed KV store DocumentationUnmaintainedyesMasterBeijing
oparentoparent/cia
?no

POLICYMaturepolicy/engine
Matureno

PORTALportalONAP Portal Platform DocumentationUnmaintainedyesGuilinGuilin
SDCsdc/sdc-distribution-clientclient
Matureno

SDCsdc/sdc-docker-base
Matureno

SDCsdc/sdc-tosca
Matureno

SDCsdc/sdc-workflow-designer
Matureno

SOso/SO Architecture documentation
Matureno

INTEGRATIONtestsuite/pythonsdk-tests
Incubationno

VIDvidVID DocumentationUnmaintainedyesHonoluluHonolulu
VFCMaturevfc/nfvo/driver/vnfm/svnfm
Matureno


Reason for the Documentation Tracking Page

...

Repository Name: Containing documentation to be published with the release (one per line)

ReadTheDocs Link: Pointing 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.

...