| Table of Contents |
|---|
IMPORTANT NOTE |
|---|
...
Beginning with the 'Jakarta' release a project/repository contributing to the documentation of the release |
|---|
...
needs to ...
|
|---|
TABLE OF CONTENTS
| Table of Contents |
|---|
Short Explanation
Table: Maintained 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 | Minor changes for Jakarta |
|
|
|
|
| |||||
| 02 | AAI | aai/sparky-be | Sparky - Inventory UI Service | Repo status: No change Doc status: No change |
|
|
|
|
|
in RTD and updated (aai/aai-common) | ||
| 03 | CCSDK | ccsdk/ |
| apps | CCSDK APPS DOCUMENTATION REPOSITORY | Repo status: No change Doc status: No change |
|
repo 'master' exists |
|
|
|
|
in RTD and updated (ccsdk/distribution) | ||
| 04 | CCSDK | ccsdk/ |
| cds | CONTROLLER DESIGN STUDIO (CDS) | Changes expected for Jakarta |
|
|
|
|
| ||
| 05 | CCSDK | ccsdk/ |
| distribution | Common Controller Software Development Kit | Changes expected for Jakarta |
|
|
|
|
|
in RTD and updated | ||
| 06 | CCSDK | ccsdk/ |
| features | SDN-R Online help | Changes expected for Jakarta |
|
repo 'master' exists |
|
|
|
|
in RTD and updated (ccsdk/distribution) | ||||||
| 07 | CCSDK | ccsdk/oran | ccsdk/oran | Changes expected for Jakarta |
|
repo 'master' exists |
|
|
|
|
in RTD and updated | ||||||
| 08 | CLI | cli | ONAP CLI | Repo status: No change Doc status: No change |
|
repo 'master' exists |
|
|
|
| ||
| 09 | CPS | cps |
| CPS |
| Documentation |
|
|
|
|
| ||
| 10 | CPS | cps/ |
| cps- |
| temporal | CPS Temporal |
|
repo 'master' exists |
|
|
|
|
| 11 |
| CPS | cps/ncmp-dmi-plugin | DMI-Plugin Documentation |
|
repo 'master' exists |
|
|
|
|
in RTD and updated | ||||||
| 12 | DCAE | dcaegen2 | Data Collection Analytics and Events (DCAE) |
|
repo 'master' exists |
|
|
|
| ||
| 13 | DMAAP | dmaap/ |
| buscontroller | dmaap/buscontroller |
|
|
|
|
| ||
| 14 | DMAAP | dmaap/ |
| datarouter | DMaaP Data Router |
|
|
|
|
|
| 15 |
ArchSubCom
Architecture Update
Thomas Kulik (doc)
Architecture Update
| DMAAP | dmaap/messagerouter/messageservice | dmaap/message router(MR) |
|
repo 'master' exists |
|
Architecture Update
|
|
|
| 16 | DOC ArchSubCom | doc | Open Network Automation Platform | Architecture Updates |
|
repo 'master' exists |
|
|
|
|
|
in RTD and updated
| ||
| 17 | HOLMES | holmes/ |
| engine-management | Holmes | Installation update due to
|
|
|
|
|
|
in RTD and updated (holmes/rule-management) | ||||||||||||||
| 18 | HOLMES | holmes/rule-management | Holmes | Installation update due to
|
|
repo 'master' exists |
|
|
|
|
| 19 |
| INTEGRATION | integration | INTEGRATION |
|
repo 'master' exists |
|
|
|
| ||
| 20 | MODELING | modeling/ |
| etsicatalog | Etsicatalog Project | Minor changes expected for Jakarta |
|
|
|
|
|
in RTD and updated | ||||||
| 21 | MODELING | modeling/modelspec | Model Specifications |
|
repo 'master' exists |
|
|
|
|
in RTD and updated | ||||||
| 22 | MSB | msb/apigateway | MSB(Microservices Bus) | Changes expected for Jakarta |
|
repo 'master' exists |
|
|
|
|
in RTD and updated | ||||||
| 23 | MSB | msb/discovery | MSB(Microservices Bus) | maintained Minor changes expected for Jakarta |
|
repo 'master' exists |
|
|
|
|
in RTD and updated (msb/apigateway) | ||||||
| 24 | MSB | msb/java-sdk | MSB(Microservices Bus) | maintained Minor changes expected for Jakarta |
|
repo 'master' exists |
|
|
|
|
in RTD and updated (msb/apigateway) | ||||||
| 25 | MSB | msb/swagger-sdk | Swagger SDK | Repo status: No change Doc status: No change |
|
repo 'master' exists |
|
|
|
|
in RTD and updated (msb/apigateway) | ||||||
| 26 | MULTICLOUD | multicloud/framework | MultiCloud Architecture | Repo status: No change Doc status: No change |
|
repo 'master' exists |
|
|
|
|
in RTD and updated | ||||||
| 27 | MULTICLOUD | multicloud/k8s | MultiCloud Kubernetes Plugin | Minor changes expected for Jakarta |
|
repo 'master' exists |
|
|
|
|
in RTD and updated (multicloud/framework) | ||||||
| 28 | OOM | oom | OOM Documentation Repository | no PTL since 2022-04-01 |
|
repo 'master' exists |
|
| ||||||
| 29 | OOM | oom/offline-installer | OOM offline-installer | Repo status: No change Doc status: No change | no PTL since 2022-04-01 |
|
repo 'master' exists |
|
|
|
|
| 30 |
| OOM | oom/platform/cert-service | OOM Certification Service | no PTL since 2022-04-01 |
|
repo 'master' exists |
|
|
|
|
repo 'master' exists
'latest' available in RTD
repo branched
'branch' available in RTD
release notes available
in RTD and updated (changelog) | ||||||
| 31 | OOF | optf/has | Optimization Framework: Homing and Allocation | Changes expected for Jakarta |
|
repo 'master' exists |
|
repo
|
|
|
in RTD and updated | ||||||
| 32 | OOF | optf/osdf | Optimization Framework: Optimization Service Design Framework (OSDF) | Changes expected for Jakarta |
|
repo 'master' exists |
|
repo
|
|
|
| 33 | SECCom | osa | ONAP Security |
|
repo 'master' exists |
|
|
|
in RTD and updated | ||||||
| 34 | POLICY | policy/parent | Policy Framework Architecture | Changes expected for Jakarta |
|
repo 'master' exists |
|
|
|
|
in RTD and updated | ||||||
| 35 | SDC | sdc | SDC Documentation | Minor changes for Jakarta |
|
repo 'master' exists |
|
|
|
|
in RTD and updated | ||||||
| 36 | SDNC | sdnc/oam | Network Controller (SDNC) | Changes expected for Jakarta |
|
repo 'master' exists |
|
|
|
|
in RTD and updated | ||||||
| 37 | SO | so | ONAP SO | Minor changes expected for Jakarta |
|
repo 'master' exists |
|
|
|
|
| 38 |
| UUI | usecase-ui | Usecase-UI(Use Case User Interface) | Minor changes expected for Jakarta |
|
|
|
|
|
in RTD and updated | ||||||
| 39 | VFC | vfc/nfvo/lcm | VF-C(Virtual Function Controller) | Minor changes expected for Jakarta |
|
repo 'master' exists |
|
|
|
|
Non-Relevant Repositories Table
in RTD and updated | |||||||
| 40 | VNFSDK | vnfsdk/model | VNFSDK Documentation | Repo status: No change Doc status: No change |
|
|
Non-Relevant Repositories Table
| # | Project Name (common abbreviation of the project or subcommittee) Responsibility: |
|---|
Project Name
(common abbreviation of the project or subcommittee)
Responsibility:
Prefill: DOC
Update: PROJECT
Repository Name
(contains documentation to be published with the upcoming release)
Responsibility:
Prefill: DOC
Update: PROJECT
ReadTheDocs Link
(link pointing to RTD 'latest' main index.rst; main title used in index.rst)
Responsibility:Prefill: DOC | Repository |
|---|
Name ( |
|---|
contains documentation to be published with the upcoming release) Responsibility: |
|---|
Documentation Owner(s)
(responsible for documentation in this repo; please use @ notation for the nameReadTheDocs Link (link pointing to RTD 'latest' main index.rst; main title used in index.rst) Responsibility: |
|---|
Documentation available:
RTD 'latest'
Prefill: DOC | 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 | VNFRQTS | vnfrqts/guidelines | VNF Guidelines | unmaintained | no PTL since 2021-11-01 |
|
|
| 02 | VNFRQTS | vnfrqts/requirements | VNF or PNF Requirements Documentation | unmaintained | no PTL since 2021-11-01 |
|
|
| 03 | VNFRQTS | vnfrqts/testcases | VNF Test Case Descriptions | unmaintained | no PTL since 2021-11-01 |
|
|
| 04 | VNFRQTS | vnfrqts/usecases | VNF Provider Use Cases | unmaintained | no PTL since 2021-11-01 |
|
|
|
DOC (Checkpoint)
Documentation available:
RTD 'branch'
| |||||||
| 05 | VVP | vvp/documentation | VVP Documentation | unmaintained |
|
|
o
'branch' available in RTD |
Responsibility:
DOC (Checkpoint)
available in RTD and updated | |||||||
Reason for the Documentation Tracking Page
...
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 (April November 2021) an ONAP release deployed via OOM consists of components whose underlying repositories include documentation and where the repositories ...
...
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.
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.
...