...
TABLE OF CONTENTS
Table of Contents |
---|
Short Explanation
Table: 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).
Table: Non-Relevant Repositories
- Containing documentation repositories no longer relevant for the upcoming release
Unmaintained Repositories
Beginning with the 'Jakarta' release, unmaintained projects/repositories are no longer contributing to the documentation if there is no TSC exception.
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) Responsibility: | Repository Status (new | changed | remove ; status of documentation; needed to e.g. identify changes in the intersphinx linking) Responsibility: | Documentation Owner(s) (responsible for documentation in this repo; please use @ notation for the name) Responsibility: | Documentation available: (relevant for new repos which are participating the first time)
Responsibility: | Documentation available:
Responsibility: |
---|---|---|---|---|---|---|---|
M2 | M2 | M2 | M2 | M2 | M4 | RC0 | |
01 | AAI | aai/aai-common | AAI Documentation Repository | changed | William Reehil stepping down 2022-12-02 |
|
|
02 | AAI | aai/sparky-be | Sparky - Inventory UI Service | no updates | William Reehil stepping down 2022-12-02 |
|
|
03 | CCSDK | ccsdk/apps | CCSDK APPS DOCUMENTATION REPOSITORY | no updates |
|
| |
04 | CCSDK | ccsdk/cds | CONTROLLER DESIGN STUDIO (CDS) | Updates to be done for Kohn release |
|
| |
05 | CCSDK | ccsdk/distribution | Common Controller Software Development Kit | Updates to be done for Kohn release |
|
| |
06 | CCSDK | ccsdk/features | SDN-R Online help | Updates to be done for Kohn release |
|
| |
07 | CCSDK | ccsdk/oran | ccsdk/oran | Updates to be done for Kohn release |
|
| |
08 | CLI | cli | ONAP CLI | Dan Xu since 2022-09-01 |
|
| |
09 | CPS | cps | CPS Documentation |
|
| ||
10 | CPS | cps/cps-temporal | CPS Temporal |
|
| ||
11 | CPS | cps/ncmp-dmi-plugin | DMI-Plugin Documentation |
|
| ||
12 | DCAE | dcaegen2 | Data Collection Analytics and Events (DCAE) | Vijay Venkatesh Kumar stepping down 2022-12-01 |
|
| |
13 | DMAAP | dmaap/buscontroller | dmaap/buscontroller |
|
| ||
14 | DMAAP | dmaap/datarouter | DMaaP Data Router |
|
| ||
15 | DMAAP | dmaap/messagerouter/messageservice | dmaap/message router(MR) |
|
| ||
16 | DOC ArchSubCom | doc | Open Network Automation Platform | Architecture Updates |
|
| |
17 | HOLMES | holmes/engine-management | Holmes | no updates |
|
| |
18 | HOLMES | holmes/rule-management | Holmes | no updates |
|
| |
19 | INTEGRATION | integration | INTEGRATION | no PTL since 2022-06-30 |
|
| |
20 | MODELING | modeling/etsicatalog | Etsicatalog Project | no updates |
|
| |
21 | MODELING | modeling/modelspec | Model Specifications |
|
| ||
22 | MSB | msb/apigateway | MSB(Microservices Bus) | Updates to be done for Kohn release |
|
| |
23 | MSB | msb/discovery | MSB(Microservices Bus) | Updates to be done for Kohn release |
|
| |
24 | MSB | msb/java-sdk | MSB(Microservices Bus) | Updates to be done for Kohn release |
|
| |
25 | MSB | msb/swagger-sdk | Swagger SDK | no updates |
|
| |
26 | MULTICLOUD | multicloud/framework | MultiCloud Architecture |
|
| ||
27 | MULTICLOUD | multicloud/k8s | MultiCloud Kubernetes Plugin |
|
| ||
28 | OOM | oom | OOM Documentation Repository | no PTL since 2022-04-01 |
|
| |
29 | OOM | oom/offline-installer | OOM offline-installer | not published in Kohn release | no PTL since 2022-04-01 |
|
|
30 | OOM | oom/platform/cert-service | OOM Certification Service | no PTL since 2022-04-01 |
|
| |
31 | OOF | optf/has | Optimization Framework: Homing and Allocation | no updates | no PTL since 2022-10-07 |
|
|
32 | OOF | optf/osdf | Optimization Framework: Optimization Service Design Framework (OSDF) | no updates | no PTL since 2022-10-07 |
|
|
33 | SECCom | osa | ONAP Security |
|
| ||
34 | POLICY | policy/parent | Policy Framework Architecture | Minor updates to be done for Kohn release. |
|
| |
35 | SDC | sdc | SDC Documentation | Updates to be done for Kohn release. |
|
| |
36 | SDNC | sdnc/oam | Network Controller (SDNC) | Updates to be done for Kohn release |
|
| |
37 | SO | so | ONAP SO | Architecture Updates |
|
| |
38 | UUI | usecase-ui | Usecase-UI(Use Case User Interface) | Architecture Updates |
|
| |
39 | VFC | vfc/nfvo/lcm | VF-C(Virtual Function Controller) | no updates |
|
| |
40 | VNFSDK | vnfsdk/model | VNFSDK Documentation | no updates | Dan Xu since 2022-09-01 |
|
|
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) Responsibility: | Repository Status (new | changed | remove ; status of documentation; needed to e.g. identify changes in the intersphinx linking) Responsibility: | Documentation Owner(s) (responsible for documentation in this repo; please use @ notation for the name) Responsibility: | Documentation available: (relevant for new repos which are participating the first time)
Responsibility: | Documentation available:
Responsibility: |
---|---|---|---|---|---|---|---|
M2 | M2 | M2 | M2 | M2 | M4 | RC0 | |
01 | |||||||
02 | |||||||
03 |
Reason for the Documentation Tracking Page
We as the doc team are responsible for providing the right set of documentation specific for every ONAP release. This release-specific set of documentation always consists of a large number of text files, formatted in the restructuredText markup language and spread over a large number of repositories. The documentation files are interlinked by the doc team using intersphinx linking functionality and config files residing in the branched doc repo. The documentation is build automatically and can be found in ReadTheDocs by choosing the respective release name. Some numbers for the Guilin release may show the scale:
...
Our target on mid- / longterm is to ged rid of manually filling out this table. Any good idea and your feedback is welcome here! Do not hesitate to contact the documentation team.
Notes for "Maintained Repositories"
In the table "Maintained Repositories" please check/update:
...