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

...

Configuration Persistence Service Documentation Documentation Architecture, APIs and Guides 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'

((error)(tick) repo 'master' exists in git/gerrit , documentation in RTD
(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 Documentation RepositoryMaintainedWilliam Reehil

(tick)

Architecture, APIs and Guides

o   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 ServiceMaintainedWilliam Reehil

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available (AAI common)

AAI Inventory UI Documentation

CCSDKccsdk/cdsController Design Studio Architecture and GuidesCONTROLLER 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/distributionTOSCA Orchestration Plugin, Directed Graph SupportCommon 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 (

Documentation (part of

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 (

O-RAN Support in ONAP (part of

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

DCAEdcaegen2DCAE Architecture and GuidesData 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/buscontrollerBus Controller Documentationdmaap/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

DMAAPdmaap/dbcapiBus Controller API

(tick) release notes available


DMAAPdmaap/messagerouter/messageserviceMessage Router Documentationdmaap/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

docONAP Master DocumentationExtAPIexternalapi/nbiOpen 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

External API Framework Documentation

HOLMESholmes/engine-managementHOLMES Engine Management DocumentationHolmesmaintainedGuangrong 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-managementHOLMES Architecture and APIsHolmesmaintained

(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

INTEGRATIONintegrationONAP Integration Project Documentation

MODELINGmodeling/etsicatalogONAP ETSI Runtime Catalog DocumentationEtsicatalog ProjectmaintainedYuanhong Deng

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

MODELINGmodeling/modelspecONAP Model SpecificationModel SpecificationsmaintainedYuanhong Deng 

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

MSBmsb/apigatewayMicroservices Bus DocumentationMSB(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

Framework Architecture and Guides

OOMoomONAP Operations Manager DocumentationOOM 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

Offline-Installer

OOMoom/platform/cert-serviceONAP CMPv2 certification supportOOM Certification Servicemaintained

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

OOFoptf/cmsohasChange Management Schedule Optimization documentationOptimization 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/hasONAP policy-driven placement optimizing service documentation

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

documentation

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

POLICYpolicy/clampCLAMP Architecture and Guides

SDCsdcService Design & Creation DocumentationSDC DocumentationmaintainedMichael Morris

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

SDNCsdnc/oamSDNC Architecture, APIs and GuidesNetwork 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

SOsoService Orchestration Architecture, APIs and Guides

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 DengVIDvid

(tick) repo 'master' exists

(tick) 'latest' available in RTD

(tick) repo branched

(tick) 'branch' available in RTD

(tick) release notes available

Virtual Infrastructure Deployment Architecture, APIs and Guides

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)

Description

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

Usecases

VNFSDKvnfsdk/modelVNF SDK Documentation and User GuidesVNFSDK 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/documentationVNF Validation Platform Documentation

...

VVP 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

Project Lifecycle State

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'

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 List


Unmaintained Repositories Table

(Source?)UnmaintainedUnmaintainedUnmaintainedUnmaintainedUnmaintainedMatureMatureMatureIncubationUnmaintainedIncubationIncubationIncubationMatureUnmaintainedMUSIC 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

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

MSBmsb/swagger-sdkMSB(Microservices Bus)Incubationno

MULTICLOUDmulticloud/azure
Matureno

MULTICLOUDMaturemulticloud/k8s
Matureno

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

POLICYMaturepolicy/engine
Matureno

PORTALUnmaintainedportalONAP Portal Platform DocumentationUnmaintainedyesGuilinGuilin
SDCsdc/sdc-distribution-client
Matureno

SDCMaturesdc/sdc-docker-base
Matureno

SDCMaturesdc/sdc-tosca
Matureno

SDCsdc/sdc-workflow-designer
Matureno

SOso/SO Architecture documentation
Matureno

INTEGRATIONtestsuite/pythonsdk-tests
Incubationno

VIDvidVID DocumentationUnmaintainedyesHonoluluHonolulu
VFCvfc/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.

...