| Table of Contents |
|---|
Short Explanation
...
Maintained Repositories
...
- 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 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.
- A request to the PROJECTS: Please check the table "Unmaintained Repositories" and move entry to the upper table, if the repository is once again maintained in the target release!
Maintained 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: (
| Documentation available: ( 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 '
| o
o | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AAI | aai/sparky-be | Sparky - | AAIInventory UI | DocumentationService | ArchitectureMaintained | William Reehil |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CCSDK | ccsdk/cds | Controller Design Studio Architecture and Guides |
| CCSDK | ccsdk/distribution | TOSCA Orchestration Plugin, Directed Graph Support |
| cds | CONTROLLER DESIGN STUDIO (CDS) | Maintained | Dan Timoney |
|
| CCSDK | ccsdk/features | SDN-R Documentation (part of CCSDK) | User Documentation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 | 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 |
...
| distribution | Common Controller Software Development Kit | Maintained | Dan Timoney |
|
| |
| CCSDK | ccsdk/features | SDN-R Online help | Maintained | Dan Timoney |
|
|
| CCSDK | ccsdk/oran | ccsdk/oran | Maintained | Dan Timoney |
|
|
| CLI | cli | ONAP CLI | Maintained |
|
- no changes - release notes not required | |
| CPS | cps | CPS Documentation |
|
| ||
| CPS | cps/cps-temporal | CPS Temporal | new |
|
| |
| CPS | cps/ncmp-dmi-plugin | DMI-Plugin Documentation | new | Toine Siebelink |
|
|
| DCAE | dcaegen2 | Data Collection Analytics and Events (DCAE) | maintained |
|
| |
| DMAAP | dmaap/buscontroller | dmaap/buscontroller | maintained |
|
| |
| DMAAP | dmaap/datarouter | DMaaP Data Router | maintained |
|
| |
| DMAAP | dmaap/messagerouter/messageservice | dmaap/message router(MR) | maintained |
|
| |
DOC
| doc | Open Network Automation Platform | maintained (doc)
|
|
| |
| HOLMES | holmes/engine-management | Holmes | maintained | Guangrong Fu |
|
|
| HOLMES | holmes/rule-management | Holmes | maintained |
|
| |
| INTEGRATION | integration | INTEGRATION | maintained | Michał Jagiełło |
|
|
| MODELING | modeling/etsicatalog | Etsicatalog Project | maintained | Yuanhong Deng |
|
|
| MODELING | modeling/modelspec | Model Specifications | maintained | Yuanhong Deng |
|
|
| MSB | msb/apigateway | MSB(Microservices Bus) | maintained | Jinquan Ni |
|
|
| MULTICLOUD | multicloud/framework | MultiCloud Architecture | maintained | Bin Yang |
|
|
| OOM | oom | OOM Documentation Repository | maintained | Sylvain Desbureaux |
|
|
| OOM | oom/offline-installer | OOM offline-installer | maintained |
|
| |
| OOM | oom/platform/cert-service | OOM Certification Service | maintained |
|
| |
| OOF | optf/has | Optimization Framework: Homing and Allocation | maintained |
|
| |
| OOF | optf/osdf | Optimization Framework: Optimization Service Design Framework (OSDF) | maintained | krishna moorthy |
|
|
| SECCom | osa | ONAP Security | maintained | Krzysztof Opasiak |
| not applicable (always 'latest') |
| POLICY | policy/parent | Policy Framework Architecture | maintained | Liam Fallon |
|
|
| SDC | sdc | SDC Documentation | maintained | Michael Morris |
|
|
| SDNC | sdnc/oam | Network Controller (SDNC) | Maintained | Dan Timoney |
|
|
| SO | so | ONAP SO | Maintained | Seshu Kumar Mudiganti |
|
|
| UUI | usecase-ui | Usecase-UI(Use Case User Interface) | maintained | xu ran |
|
|
| VFC | vfc/nfvo/lcm | VF-C(Virtual Function Controller) | maintained | Yuanhong Deng |
|
|
| VNFRQTS | vnfrqts/guidelines | VNF Guidelines | maintained |
|
| |
| VNFRQTS | vnfrqts/requirements | VNF or PNF Requirements Documentation | maintained |
|
| |
| VNFRQTS | vnfrqts/testcases | VNF Test Case Descriptions | maintained |
|
| |
| VNFRQTS | vnfrqts/usecases | VNF Provider Use Cases | maintained |
|
| |
| VNFSDK | vnfsdk/model | VNFSDK Documentation | Maintained | user-67d6f |
|
- no changes - release notes not required |
| VVP | vvp/documentation | VVP Documentation | maintained |
|
|
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 |
Unmaintained Repositories Table
Project Name (common abbreviation of the project or subcommittee) DOC | 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 ( | pointing to RTD latestONAP 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 | Unmaintained | aaf/authz | AAF Architecture, APIs and Guides- Application Authorization Framework | Unmaintained | yes | Master | Frankfurt | ||
| AAF | Unmaintainedaaf/certservice | Unmaintained | no | Frankfurt | |||||
| AAF | Unmaintained | aaf/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 | Unmaintained | appc | APPC Architecture, APIs and GuidesDocumentation Repository | Unmaintained | yes | Frankfurt | Frankfurt | ||
| APPC | Unmaintained | appc/deployment | APPC Deployment Documentation | Unmaintained | yes | Frankfurt | Frankfurt | ||
| CCSDK | Matureccsdk/apps | Mature | no | Honolulu | |||||
| CCSDK | Matureccsdk/dashboard | Mature | no | Honolulu | |||||
| CCSDK | Matureccsdk/platform/blueprints | Mature | no | Master | |||||
| CCSDK | Matureccsdk/platform/nbapi | Mature | no | Amsterdam | |||||
| CCSDK | Matureccsdk/platform/plugins | Mature | no | Elalto | |||||
| ExtAPI | externalapi/nbi | ONAP ExternalAPI / NBI | yes | Honolulu | Honolulu | ||||
| INTEGRATION | INTEGRATION | Incubationintegration/benchmark | Incubation | no | Casablanca | ||||
| INTEGRATION | Incubation | integration/devtool | Incubation | no | Casablanca | ||||
| INTEGRATION | Incubation | integration/simulators/pnf-simulator | Incubation | no | Frankfurt | ||||
| LOGGING | Unmaintainedlogging-analytics | ONAP Centralized Logging Documentation Repository | Unmaintained | yes | Master | Elalto | |||
| LOGGING | Unmaintainedlogging-analytics/pomba/pomba-audit-common | Unmaintained | no | Elalto | |||||
| MODELING | Mature | modeling/toscaparsers | Mature | no | Elalto | ||||
| MSB | msb/discovery | MSB(Microservices Bus) | Incubation | msb/discoveryno | Honolulu | ||||
| MSB | Incubation | msb/java-sdk | MSB(Microservices Bus) | Incubation | no | ||||
| MSB | Incubation | msb/swagger-sdk | MSB(Microservices Bus) | Incubation | no | ||||
| MULTICLOUD | Mature | multicloud/azure | Mature | no | |||||
| MULTICLOUD | Mature | multicloud/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 | Maturepolicy/engine | Mature | no | ||||||
| PORTAL | Unmaintainedportal | ONAP Portal Platform Documentation | Unmaintained | yes | Guilin | Guilin | |||
| SDC | Maturesdc/sdc-distribution-client | Mature | no | ||||||
| SDC | Maturesdc/sdc-docker-base | Mature | no | ||||||
| SDC | Maturesdc/sdc-tosca | Mature | no | ||||||
| SDC | Mature | sdc/sdc-workflow-designer | Mature | no | |||||
| SO | Mature | so/libs | Mature | no | |||||
| INTEGRATION | Incubationtestsuite/pythonsdk-tests | Incubation | no | ||||||
| VID | vid | VID Documentation | Unmaintained | yes | Honolulu | Honolulu | |||
| VFC | Maturevfc/nfvo/driver/vnfm/svnfm | Mature | no |
Reason for the Documentation Tracking Page
...
- the required components, the documentation files and their correct version for the upcoming release and
- the appropriate steps which have to be taken by the doc team to prepare the release-specific set of documentation (e.g. intersphinx linking).
But with the tables below on this page and a little help from the projects and release management it will be possible to identify all relevant files and related actions. Only the first table must (partly) be maintained by the projects!
...
In the table "Maintained Repositories" please check/update:
Project Name: Use the common abbreviation of the project or subcommittee.
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.
Documentation Owner(s): Please name responsible persons for documentation in this repo. Please use @ notation (e.g. David McBride for the name)Check the the table Istanbul Documentation#Unmaintained Repositories and move repositories
A request to the PROJECTS: Please check the table "Unmaintained Repositories" and move entry to the upper table, if the repository is once again maintained in the target release!