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

...

Prefill: DOC
Update: PROJECT

Content

(categories of the provided documentation)M2 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)

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)


PROJECTResponsibility:
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
  • Release Notes
  • Installation

  • Developer Guide

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 ServiceArchitectureMaintained
  • Installation
  • User Guide
  • William 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 Architecture and Guides
    • Architecture
    • Developer Guide
    • Installation
    • User Guide
    CCSDKccsdk/distributionTOSCA Orchestration Plugin, Directed Graph SupportcdsCONTROLLER 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)

  • Tosca Plugins
  • DG Support
  • CCSDK Release Notes

    CCSDKccsdk/featuresSDN-R Documentation (part of CCSDK)
    • User Documentation

    CCSDKccsdk/oranO-RAN Support in ONAP (part of CCSDK)
    • Architecture
    • Developer Guide
    • APIs
    • Human Interfaces
    • Release Notes
    CLIcliCLI Documentation
    • Architecture
    • Developer Guide
    • User Guide
    • Installation Guide
    • Release Notes
    CPScpsConfiguration Persistence Service
    • Architecture
    • User Guide
    • Design Guide
    • Release Notes
    DCAEdcaegen2DCAE Architecture and Guides
    • Architecture
    • APIs
    • User Guides
    • Design Guide
    • Release Notes
    DMAAPdmaap/buscontrollerBus Controller Documentation
    • Architecture
    • APIs
    • User Guides
    • Admin Guide
    • Release Notes
    DMAAPdmaap/datarouterData Router DocumentationDMAAPdmaap/dbcapiBus Controller APIDMAAPdmaap/messagerouter/messageserviceMessage Router Documentation

    DOC

    ArchSubCom

    docONAP Master DocumentationExtAPIexternalapi/nbiExternal API Framework DocumentationHOLMESholmes/engine-managementHOLMES Engine Management DocumentationHOLMESholmes/rule-managementHOLMES Architecture and APIsINTEGRATIONintegrationONAP Integration Project DocumentationMODELINGmodeling/etsicatalogONAP ETSI Runtime Catalog DocumentationMODELINGmodeling/modelspecONAP Model SpecificationMSBmsb/apigatewayMicroservices Bus DocumentationMULTICLOUDmulticloud/frameworkMultiCloud Framework Architecture and GuidesOOMoomONAP Operations Manager DocumentationOOMoom/offline-installerOOM Offline-InstallerOOMoom/platform/cert-serviceONAP CMPv2 certification supportdistributionCommon 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

    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 ListOOFoptf/cmsoChange Management Schedule Optimization documentationOOFoptf/hasONAP policy-driven placement optimizing service documentationOOFoptf/osdfOptimization Service Design Framework documentationSECComosaONAP SecurityPOLICYpolicy/parentPolicy Framework DocumentationPOLICYpolicy/clampCLAMP Architecture and Guides
    • User Guide
    SDCsdcService Design & Creation DocumentationSDNCsdnc/oamSDNC Architecture, APIs and GuidesSOsoService Orchestration Architecture, APIs and GuidesUUIusecase-uiUsecase-UI Architecture, APIs and GuidesVFCvfc/nfvo/lcmVirtual Function Controller Architecture, APIs and GuidesVIDvidVirtual 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 Documentation


    Unmaintained Repositories Table

    Project Lifecycle State

    (Source?)UnmaintainedUnmaintainedUnmaintainedUnmaintainedMatureUnmaintainedMatureMatureMatureIncubationIncubationMatureIncubationMatureMatureUnmaintainedMUSIC Architecture and GuidesUnmaintainedMatureMatureMatureMatureMature

    Project Name

    (common abbreviation of the project or subcommittee)

    DOC

    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
    AAFaaf/certservice
    Unmaintainedno
    Frankfurt
    AAFaaf/sms
    Unmaintainedno
    Frankfurt
    AAIUnmaintainedaai/esr-guiExternal System Registry GUI DocumentationyesAAI-esr-serverUnmaintainednoMaster
    Frankfurt
    AAIaai/esr-serverExternal System Registry Server DocumentationyesAAI-esr-serverUnmaintainednoMaster
    Frankfurt
    AAIaai/event-client
    Matureno
    Honolulu
    APPCappcAPPC Architecture, APIs and GuidesDocumentation RepositoryUnmaintainedyesFrankfurtFrankfurt
    APPCUnmaintainedappc/deploymentAPPC Deployment DocumentationUnmaintainedyesFrankfurtFrankfurt
    CCSDKMatureccsdk/apps
    Matureno
    Honolulu
    CCSDKccsdk/dashboard
    Matureno
    Honolulu
    CCSDKMatureccsdk/platform/blueprints
    Matureno
    Master
    CCSDKccsdk/platform/nbapi
    Matureno
    Amsterdam
    CCSDKccsdk/platform/plugins
    Matureno
    Elalto
    ExtAPIexternalapi/nbiONAP ExternalAPI / NBI
    yesHonoluluHonolulu
    INTEGRATIONintegration/benchmark
    Incubationno
    Casablanca
    INTEGRATIONintegration/devtool
    Incubationno
    Casablanca
    INTEGRATIONIncubationintegration/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
    MSBmsb/java-sdkMSB(Microservices Bus)Incubationno

    MSBIncubationmsb/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
    oparent?oparent/cia
    ?no

    POLICYMaturepolicy/engine
    Matureno

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

    SDCsdc/sdc-docker-base
    Matureno

    SDCsdc/sdc-tosca
    Matureno

    SDCsdc/sdc-workflow-designer
    Matureno

    SOso/libs
    Matureno

    INTEGRATIONIncubationtestsuite/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' !Content: 'Categories' of the provided documentationmain 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.

    ...