...
| # | 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) ( see also History of PTL ) 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 no PTL since 2022-12-02 |
|
| |||||||
| 02 | AAI | aai/sparky-be | Sparky - Inventory UI Service | no William Reehil stepping down PTL since 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 releasechanged |
|
| ||||||||
| 05 | CCSDK | ccsdk/distribution | Common Controller Software Development Kit | Updates to be done for Kohn releasechanged |
|
| ||||||||
| 06 | CCSDK | ccsdk/features | SDN-R Online help | Updates to be done for Kohn releasechanged |
|
| ||||||||
| 07 | CCSDK | ccsdk/oran | ccsdk/oran | Updates to be done for Kohn releasechanged |
|
| ||||||||
| 08 | CLI | cli | ONAP CLI | Dan Xu since 2022-09-01 |
|
| ||||||||
| 09 | CPS | cps | CPS Documentation | no updates |
|
| ||||||||
| 10 | CPS | cps/cps-temporal | CPS Temporal | no updates | According to Toine Siebelink the project is no longer maintained. To be removed? |
|
| |||||||
| 11 | CPS | cps/ncmp-dmi-plugin | DMI-Plugin Documentation | no updates |
|
| ||||||||
| 12 | DCAE | dcaegen2 | Data Collection Analytics and Events (DCAE) | DCAE Mod retired (no change in root documentation repo) | no PTL since 2022-12Vijay 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 | no updates |
|
| ||||||||
| 22 | MSB | msb/apigateway | MSB(Microservices Bus) | Updates to be done for Kohn releaseno updates |
|
| ||||||||
| 23 | MSB | msb/discovery | MSB(Microservices Bus) | swagger-sdk | Swagger SDK | no updates Updates to be done for Kohn release |
|
| ||||||
| 24MSB | MULTICLOUD | msbmulticloud/ | java-sdkMSB(Microservices Bus) | Updates to be done for Kohn release | Jinquan Niframework | MultiCloud Architecture | stepping down as PTL 2023-04-24 |
|
|
| ||||
| (msb/apigateway)25 | MSBMULTICLOUD | msbmulticloud/swagger-sdk | Swagger SDK | no updates | k8s | MultiCloud Kubernetes Plugin | stepping down as PTL 2023-04-24 |
|
multicloud/ framework) | |||||
| 26 | MULTICLOUDOOM | multicloud/framework | MultiCloud Architecture | oom | OOM Documentation Repository | changed: will be updated to reflect the London changes (ServiceMesh, AAF removal, Ingress) | no PTL since 2022-04-01 |
|
| |||||
| 27MULTICLOUD | OOF | multicloudoptf/ | k8shas | Optimization Framework: Homing and Allocation | no PTL since 2022-10-07 |
| MultiCloud Kubernetes Plugin | docs config up-to-date
|
|
| ||||
| (multicloud/framework)28 | OOMOOF | oom | optf/osdf | Optimization Framework: Optimization Service Design Framework (OSDF)OOM Documentation Repository | no PTL since 2022- 0410- 0107 |
|
| |||||||
| 29 | OOMPOLICY | oompolicy/offline-installer | OOM offline-installer | not published in Kohn release | no PTL since 2022-04-01 | parent | Policy Framework Architecture | No updates |
|
| ||||
| 30 | OOM | oom/platform/cert-service | OOM Certification Service | no PTL since 2022-04-01Portal-NG | portal-ng | Portal-NG | POC - currently no docs available | Georg Schweflinghaus |
|
|
|
|
|
|
| 31 | OOFSECCom | optf/has | Optimization Framework: Homing and Allocation | no updates | no PTL since 2022-10-07 | osa | ONAP Security |
 docs config up-to-date
|
| |||||
| 32 | OOFSDC | optf/osdf | Optimization Framework: Optimization Service Design Framework (OSDF) | no updates | no PTL since 2022-10-07 | sdc | SDC Documentation |
|
| |||||
| 33 | SDNC | SECCom | osa | ONAP Security | sdnc/oam | Network Controller (SDNC) | changed |
docs config up-to-date
|
| |||||
| 34 | SO | POLICY | policy/parent | Policy Framework Architecture | Minor updates to be done for Kohn release. | so | ONAP SO | General platform update Architecture |
|
| ||||
| 35 | SDCUUI | sdc | SDC Documentation | Updates to be done for Kohn release. | usecase-ui | Usecase-UI(Use Case User Interface) |
|
| ||||||
| 36 | SDNCVFC | sdncvfc/nfvo/oam | Network Controller (SDNC) | Updates to be done for Kohn release | lcm | VF-C(Virtual Function Controller) | no PTL since 22-12-05 |
|
| |||||
| 37 | SOVNFSDK | so | ONAP SO | vnfsdk/model | VNFSDK Documentation |
|
|
| ||||||
| 38 | UUI | usecase-ui | Usecase-UI(Use Case User Interface) | Architecture Updates |
|
| ||||||||
updated |
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: | 39 | VFC | vfc/nfvo/lcm | VF-C(Virtual Function Controller) | no updates | Yuanhong Deng stepping down 22-12-05 | Documentation available: (relevant for new repos which are participating the first time)
|
| Responsibility: | Documentation available:
| branch' available in RTD Responsibility: |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| M2 | M2 | M2 | M2 | M2 | M4 | RC0 | ||||||||||
| 01 | oom/offline-installer | OOM offline-installer | remove: not maintained anymore | no PTL since 2022-04-01 | and updated40 | VNFSDK | vnfsdk/model | VNFSDK Documentation | no updates | Dan Xu since 2022-09-01 |
|
|
Non-Relevant Repositories Table
| 02 | oom/platform/cert-service | OOM Certification Service | remove: will not be needed, as AAF will be removed | no PTL since 2022-04-01 |
|
| ||||||||||||||||||||
| 03 | MSB | msb/discovery | MSB(Microservices Bus) | no updates |
|
| ||||||||||||||||||||
| 04 | MSB | msb/java-sdk | MSB(Microservices Bus) | no updates |
| # | 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: |
|
|
| 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:
- 987 text files (out of 1296 in master)
- spread over 58 repositories (out of 97 in master)
- grouped in 26 projects (out of 37 in master)
Please note that we are counting only repos and projects which contain docs in the Guilin release! And also note, that the numbers do not include text files, repositories and projects for components that are added to the release by the OOM team (see below). Those must be added to the above listed numbers!
To create a release-specific set of documentation it is essential for the doc team to know, which components are part of the upcoming ONAP release. To be more concrete: We need to know which components are deployed when ONAP is installed via OOM. And we need to know this on repository level - not on project or container level because documentation files are found in the repositories for the deployed ONAP components.
As of now (November 2021) an ONAP release deployed via OOM consists of components whose underlying repositories include documentation and where the repositories ...
- are actively maintained by the project, have branched for the upcoming release and are part of it
- or actively maintained by the project, have never branched but are also part of the upcoming ONAP release
- or no longer maintained by anyone (unmaintained state), have not branched for the upcoming but for an earlier release and are part of the upcoming ONAP release for a good reason
- or no longer maintained by anyone (unmaintained state), have never branched but are part of the upcoming ONAP release for a good reason
In addition (and unfortunately) components exist where the repositories ...
- are actively maintained by the project, have branched for the upcoming release but they are not part of the upcoming release.
This makes it very difficult to identify ...
- 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 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!
To reduce complexity and to avoid confusion and misunderstanding for the reader we decided to remove documentation for unmaintained projects/repositories.
...
and updated (msb/apigateway) | |||||||
| 00 | |||||||
| 00 | |||||||
| 00 |
Notes for "Maintained Repositories"
...