Versions Compared

Key

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

...

Project Name

(common abbreviation of the project or subcommittee)

Prefill: DOC
Update: PROJECT

Repository Name

(contains documentation to be published with the upcoming release)

Prefill: DOC
Update: PROJECT

ReadTheDocs Link

(pointing to RTD 'latest')

Prefill: DOC
Update: PROJECT

Content

(categories of the provided documentation)

Prefill: DOC
Update: PROJECT

Repository Status

(new | maintained | remove ; needed to e.g. identify changes in the intersphinx linking)

PROJECT

Documentation Owner(s)

(responsible for documentation in this repo; please use @ notation for the name)

PROJECT

Documentation available: RTD 'latest'

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

DOC (Checkpoint)

Documentation available: RTD 'branch'

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

DOC (Checkpoint)

M2M2M2M2M2M2M4RC0
AAIaai/aai-commonAAI Architecture, APIs and Guides
  • Architecture
  • Release Notes
  • Installation

  • Developer Guide



o   repo 'master' exists
o   available @ RTD 'latest'

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

AAIaai/sparky-beSparky - AAI Inventory UI Documentation
  • Architecture
  • Installation
  • User Guide




  • CCSDKccsdk/cdsController Design Studio Architecture and Guides
    • Architecture
    • Developer Guide
    • Installation
    • User Guide




    CCSDKccsdk/distributionTOSCA Orchestration Plugin, Directed Graph Support
  • Tosca Plugins
  • DG Support




    CCSDK Release NotesCCSDKccsdk/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 Documentation



    DMAAPdmaap/dbcapiBus Controller API



    DMAAPdmaap/messagerouter/messageserviceMessage Router Documentation



    DOC

    ArchSubCom

    docONAP Master Documentation



    ExtAPIexternalapi/nbiExternal API Framework Documentation



    HOLMESholmes/engine-managementHOLMES Engine Management Documentation



    HOLMESholmes/rule-managementHOLMES Architecture and APIs



    INTEGRATIONintegrationONAP Integration Project Documentation



    MODELINGmodeling/etsicatalogONAP ETSI Runtime Catalog Documentation



    MODELINGmodeling/modelspecONAP Model Specification



    MSBmsb/apigatewayMicroservices Bus Documentation



    MULTICLOUDmulticloud/frameworkMultiCloud Framework Architecture and Guides



    OOMoomONAP Operations Manager Documentation



    OOMoom/offline-installerOOM Offline-Installer



    OOMoom/platform/cert-serviceONAP CMPv2 certification support



    OOFoptf/cmsoChange Management Schedule Optimization documentation



    OOFoptf/hasONAP policy-driven placement optimizing service documentation



    OOFoptf/osdfOptimization Service Design Framework documentation



    SECComosaONAP Security



    POLICYpolicy/parentPolicy Framework Documentation



    POLICYpolicy/clampCLAMP Architecture and Guides
    • User Guide




    SDCsdcService Design & Creation Documentation



    SDNCsdnc/oamSDNC Architecture, APIs and Guides



    SOsoService Orchestration Architecture, APIs and Guides



    UUIusecase-uiUsecase-UI Architecture, APIs and Guides



    VFCvfc/nfvo/lcmVirtual Function Controller Architecture, APIs and Guides



    VIDvidVirtual Infrastructure Deployment Architecture, APIs and Guides



    VNFRQTSvnfrqts/guidelinesVNF Guidelines



    VNFRQTSvnfrqts/requirementsVNF or PNF Requirements Documentation



    VNFRQTSvnfrqts/testcasesVNF Test Case Description



    VNFRQTSvnfrqts/usecasesVNF Provider Usecases



    VNFSDKvnfsdk/modelVNF SDK Documentation and User Guides



    VVPvvp/documentationVNF Validation Platform Documentation










    ...

    ReadTheDocs Link: Pointing to RTD 'latest'!Content: 'Categories' of the provided documentation.

    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.

    ...