...
- 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
- Existing repositories containing documents,
- which are belonging to an active project, but not used in the ONAP documentation
- which are belnging 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.
- Repository could be "reactivated" by the ONAP project in the upcoming release
- A request to the PROJECTS: Please check the table "Unmaintained Repositories" and move repositories entry to the upper table, if the repository is once again maintained in the target release!
...
Project Name (common abbreviation of the project or subcommittee) Responsibility: | Repository Name (contains documentation to be published with the upcoming release) Responsibility: | ReadTheDocs Link (link pointing to RTD 'latest' main index.rst; main title used in index.rst)
| Content (categories of the provided documentation) Prefill: DOC | Repository Status (new | maintained | remove ; needed to e.g. identify changes in the intersphinx linking)
| Documentation Owner(s) (responsible for documentation in this repo; please use @ notation for the name)
| Documentation available: ( repo 'master' exists in git/gerrit , documentation in RTD
| Documentation available: ( repo 'branch' exists in git/gerrit; documentation in RTD 'branch' available; release notes are final) Responsibility: | M2|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
M2 | M2 | M2 | M2 | M2 | M4 | RC0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AAI | aai/aai-common | AAI | Architecture, APIs and GuidesDocumentation Repository | Maintained | William Reehil |
|
| o repo 'master' existso available @ RTD 'latest' available in RTD | repo branched 'o repo 'branch' exists o release notes are finalavailable | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AAI | aai/sparky-be | Sparky - | AAIInventory UI | DocumentationService | ArchitectureMaintained | William Reehil | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available (AAI common) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CCSDK | ccsdk/cds | Controller Design Studio Architecture and Guides |
| CCSDK | ccsdk/distribution | TOSCA Orchestration Plugin, Directed Graph Support |
| CCSDK | ccsdk/features | SDN-R Documentation (part of CCSDK) |
| CCSDK | ccsdk/oran | O-RAN Support in ONAP (part of CCSDK) |
| CLI | cli | CLI Documentation |
| CPS | cps | Configuration Persistence Service |
| DCAE | dcaegen2 | DCAE Architecture and Guides |
| DMAAP | dmaap/buscontroller | Bus Controller Documentation |
| DMAAP | dmaap/datarouter | Data Router Documentation | DMAAP | dmaap/dbcapi | Bus Controller API | DMAAP | dmaap/messagerouter/messageservice | Message Router Documentation | DOC ArchSubCom | doc | ONAP Master Documentation | ExtAPI | externalapi/nbi | External API Framework Documentation | HOLMES | holmes/engine-management | HOLMES Engine Management Documentation | HOLMES | holmes/rule-management | HOLMES Architecture and APIs | INTEGRATION | integration | ONAP Integration Project Documentation | MODELING | modeling/etsicatalog | ONAP ETSI Runtime Catalog Documentation | MODELING | modeling/modelspec | ONAP Model Specification | MSB | msb/apigateway | Microservices Bus Documentation | MULTICLOUD | multicloud/framework | MultiCloud Framework Architecture and Guides | OOM | oom | ONAP Operations Manager Documentation | OOM | oom/offline-installer | OOM Offline-Installer | OOM | oom/platform/cert-service | ONAP CMPv2 certification support | cds | CONTROLLER DESIGN STUDIO (CDS) | Maintained | Dan Timoney | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available (CCSDK) |
CCSDK | ccsdk/distribution | Common Controller Software Development Kit | Maintained | Dan Timoney | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CCSDK | ccsdk/features | SDN-R Online help | Maintained | Dan Timoney | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available (CCSDK) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CCSDK | ccsdk/oran | ccsdk/oran | Maintained | Dan Timoney | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available (CCSDK) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CLI | cli | ONAP CLI | Maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD - no changes - release notes not required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CPS | cps | CPS Documentation | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CPS | cps/cps-temporal | CPS Temporal | new | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CPS | cps/ncmp-dmi-plugin | DMI-Plugin Documentation | new | Toine Siebelink | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DCAE | dcaegen2 | Data Collection Analytics and Events (DCAE) | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DMAAP | dmaap/buscontroller | dmaap/buscontroller | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DMAAP | dmaap/datarouter | DMaaP Data Router | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DMAAP | dmaap/messagerouter/messageservice | dmaap/message router(MR) | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DOC ArchSubCom | doc | Open Network Automation Platform | maintained (doc) Architecture Update | repo 'master' exists 'latest' available in RTD Architecture Update | repo branched 'branch' available in RTD release notes available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HOLMES | holmes/engine-management | Holmes | maintained | Guangrong Fu | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available (rule-management) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HOLMES | holmes/rule-management | Holmes | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
INTEGRATION | integration | INTEGRATION | maintained | Michał Jagiełło | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MODELING | modeling/etsicatalog | Etsicatalog Project | maintained | Yuanhong Deng | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MODELING | modeling/modelspec | Model Specifications | maintained | Yuanhong Deng | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MSB | msb/apigateway | MSB(Microservices Bus) | maintained | Jinquan Ni | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MULTICLOUD | multicloud/framework | MultiCloud Architecture | maintained | Bin Yang | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OOM | oom | OOM Documentation Repository | maintained | Sylvain Desbureaux | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OOM | oom/offline-installer | OOM offline-installer | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes not required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OOM | oom/platform/cert-service | OOM Certification Service | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OOF | optf/has | Optimization Framework: Homing and Allocation | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OOF | optf/osdf | Optimization Framework: Optimization Service Design Framework (OSDF) | maintained | krishna moorthy | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SECCom | osa | ONAP Security | maintained | Krzysztof Opasiak | repo 'master' exists 'latest' available in RTD | not applicable (always 'latest') | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
POLICY | policy/parent | Policy Framework Architecture | maintained | Liam Fallon | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SDC | sdc | SDC Documentation | maintained | Michael Morris | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SDNC | sdnc/oam | Network Controller (SDNC) | Maintained | Dan Timoney | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SO | so | ONAP SO | Maintained | Seshu Kumar Mudiganti | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UUI | usecase-ui | Usecase-UI(Use Case User Interface) | maintained | xu ran | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VFC | vfc/nfvo/lcm | VF-C(Virtual Function Controller) | maintained | Yuanhong Deng | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VNFRQTS | vnfrqts/guidelines | VNF Guidelines | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes not required | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VNFRQTS | vnfrqts/requirements | VNF or PNF Requirements Documentation | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VNFRQTS | vnfrqts/testcases | VNF Test Case Descriptions | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VNFRQTS | vnfrqts/usecases | VNF Provider Use Cases | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VNFSDK | vnfsdk/model | VNFSDK Documentation | Maintained | user-67d6f | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD - no changes - release notes not required | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
VVP | vvp/documentation | VVP Documentation | maintained | repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available |
Non-Relevant Repositories Table
Project Name (common abbreviation of the project or subcommittee) Responsibility: | Repository Name (contains documentation to be published with the upcoming release) Responsibility: | ReadTheDocs Link (link pointing to RTD 'latest' main index.rst; main title used in index.rst)
| Repository Status (new | maintained | remove ; needed to e.g. identify changes in the intersphinx linking)
| Documentation Owner(s) (responsible for documentation in this repo; please use @ notation for the name)
| Documentation available: o repo 'master' exists
| Documentation available: o repo 'branch' exists Responsibility: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
M2 | M2 | M2 | M2 | M2 | M4 | RC0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
DMAAP | dmaap/dbcapi | DMaaP Bus Controller REST API | removed from ONAP Component List | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MSB | msb/discovery | MSB(Microservices Bus) | maintained | no documentation and not referenced (see table below) Jinquan Ni The document is included in MSB(Microservices Bus) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MSB | msb/java-sdk | MSB(Microservices Bus) | maintained | Jinquan Ni | no documentation and not referenced (see table below) Jinquan Ni The document is included in MSB(Microservices Bus) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OOF | optf/cmso | Optimization Framework: Change Management Schedule Optimization | removed from ONAP Component List | OOF | optf/cmso | Change Management Schedule Optimization documentation | OOF | optf/has | ONAP policy-driven placement optimizing service documentation | OOF | optf/osdf | Optimization Service Design Framework documentation | SECCom | osa | ONAP Security | POLICY | policy/parent | Policy Framework Documentation | POLICY | policy/clamp | CLAMP Architecture and Guides |
| SDC | sdc | Service Design & Creation Documentation | SDNC | sdnc/oam | SDNC Architecture, APIs and Guides | SO | so | Service Orchestration Architecture, APIs and Guides | UUI | usecase-ui | Usecase-UI Architecture, APIs and Guides | VFC | vfc/nfvo/lcm | Virtual Function Controller Architecture, APIs and Guides | VID | vid | Virtual Infrastructure Deployment Architecture, APIs and Guides | VNFRQTS | vnfrqts/guidelines | VNF Guidelines | VNFRQTS | vnfrqts/requirements | VNF or PNF Requirements Documentation | VNFRQTS | vnfrqts/testcases | VNF Test Case Description | VNFRQTS | vnfrqts/usecases | VNF Provider Usecases | VNFSDK | vnfsdk/model | VNF SDK Documentation and User Guides | VVP | vvp/documentation | VNF Validation Platform Documentation |
Unmaintained Repositories Table
Project Name (common abbreviation of the project or subcommittee) DOC | or subcommittee) Responsibility: | Repository Name (may contain documentation to be published with the upcoming release)
| ReadTheDocs Link (link pointing to RTD 'latest' main index.rst; main title used in index.rst) Responsibility: | Project Lifecycle State (ONAP Dev Wiki)
| Docs In This Repo Are Part Of The Upcoming Release Responsibility: | Name of Branch Used In The Upcoming Release Responsibility: | Name of Latest Available Branch
| ||
---|---|---|---|---|---|---|---|---|---|
AAF | Unmaintainedaaf/authz | AAF Architecture, APIs and Guides- Application Authorization Framework | Unmaintained | yes | Master | Frankfurt | |||
AAF | Unmaintained | aaf/certservice | Unmaintained | no | Frankfurt | ||||
AAF | Unmaintainedaaf/sms | Unmaintained | no | Frankfurt | |||||
AAI | Unmaintainedaai/esr-gui | External System Registry GUI Documentation | yes | AAI-esr-server | Unmaintained | noMaster | Frankfurt | ||
AAI | Unmaintainedaai/esr-server | External System Registry Server Documentation | yes | AAI-esr-server | Unmaintained | noMaster | Frankfurt | ||
AAI | Mature | aai/event-client | Mature | no | Honolulu | ||||
APPC | Unmaintainedappc | APPC Architecture, APIs and GuidesDocumentation Repository | Unmaintained | yes | Frankfurt | Frankfurt | |||
APPC | Unmaintained | appc/deployment | APPC Deployment Documentation | Unmaintained | yes | Frankfurt | Frankfurt | ||
CCSDK | Mature | ccsdk/apps | Mature | no | Honolulu | ||||
CCSDK | Mature | ccsdk/dashboard | Mature | no | Honolulu | ||||
CCSDK | Matureccsdk/platform/blueprints | Mature | no | Master | |||||
CCSDK | Mature | ccsdk/platform/nbapi | Mature | no | Amsterdam | ||||
CCSDK | Matureccsdk/platform/plugins | Mature | no | Elalto | |||||
ExtAPI | externalapi/nbi | ONAP ExternalAPI / NBI | yes | Honolulu | Honolulu | ||||
INTEGRATION | Incubationintegration/benchmark | Incubation | no | Casablanca | |||||
INTEGRATION | Incubationintegration/devtool | Incubation | no | Casablanca | |||||
INTEGRATION | Incubationintegration/simulators/pnf-simulator | Incubation | no | Frankfurt | |||||
LOGGING | Unmaintained | logging-analytics | ONAP Centralized Logging Documentation Repository | Unmaintained | yes | Master | Elalto | ||
LOGGING | Unmaintained | logging-analytics/pomba/pomba-audit-common | Unmaintained | no | Elalto | ||||
MODELING | Mature | modeling/toscaparsers | Mature | no | Elalto | ||||
MSB | Incubationmsb/discovery | MSB(Microservices Bus) | Incubation | no | Honolulu | ||||
MSB | Incubation | msb/java-sdk | MSB(Microservices Bus) | Incubation | no | ||||
MSB | Incubationmsb/swagger-sdk | MSB(Microservices Bus) | Incubation | no | |||||
MULTICLOUD | Maturemulticloud/azure | Mature | no | ||||||
MULTICLOUD | Maturemulticloud/k8s | Mature | no | ||||||
MUSIC | Unmaintainedmusic | music | MUSIC Architecture and GuidesMusic Developer Documentation | Unmaintained | yes | Frankfurt | Frankfurt | ||
MUSIC | Unmaintained | music/distributed-kv-storeMUSIC Distribute KV Store Documents | Distributed KV store Documentation | Unmaintained | yes | Master | Beijing | ||
oparent | ? | oparent/cia | ? | no | |||||
POLICY | Mature | policy/engine | Mature | no | |||||
PORTAL | Unmaintained | portal | ONAP Portal Platform Documentation | Unmaintained | yes | Guilin | Guilin | ||
SDC | Mature | sdc/sdc-distribution-client | Mature | no | |||||
SDC | Maturesdc/sdc-docker-base | Mature | no | ||||||
SDC | Maturesdc/sdc-tosca | Mature | no | ||||||
SDC | Maturesdc/sdc-workflow-designerdesigner | Mature | no | ||||||
SO | Matureso/libs | Mature | no | ||||||
INTEGRATION | Incubationtestsuite/pythonsdk-tests | Incubation | no | ||||||
VID | vid | VID Documentation | Unmaintained | yes | Honolulu | Honolulu | |||
VFC | Mature | vfc/nfvo/driver/vnfm/svnfm | Mature | no |
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.
...
A request to the PROJECTS: Please check the table "Unmaintained Repositories" and move repositories entry to the upper table, if the repository is once again maintained in the target release!
...