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
- 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
- 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
- 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 | Minor changes for Jakarta |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
02 | AAI | aai/sparky-be | Sparky - Inventory UI Service | Repo status: No change Doc status: No change |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
03 | CCSDK | ccsdk/apps | CCSDK APPS DOCUMENTATION REPOSITORY | Repo status: No change Doc status: No change |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
06 | CCSDK | ccsdk/features | SDN-R Online help | Changes expected for Jakarta |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
07 | CCSDK | ccsdk/oran | ccsdk/oran | Changes expected for Jakarta |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
08 | CLI | cli | ONAP CLI | Repo status: No change Doc status: No change |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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) |
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | Installation update due to
|
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
18 | HOLMES | holmes/rule-management | Holmes | Installation update due to
|
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
19 | INTEGRATION | integration | INTEGRATION |
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
20 | MODELING | modeling/etsicatalog | Etsicatalog Project | Minor changes expected for Jakarta |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
21 | MODELING | modeling/modelspec | Model Specifications |
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
22 | MSB | msb/apigateway | MSB(Microservices Bus) | Changes expected for Jakarta |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
23 | MSB | msb/discovery | MSB(Microservices Bus) | maintained Minor changes expected for Jakarta |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
24 | MSB | msb/java-sdk | MSB(Microservices Bus) | maintained Minor changes expected for Jakarta |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
25 | MSB | msb/swagger-sdk | Swagger SDK | Repo status: No change Doc status: No change |
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
26 | Project Name (common abbreviation of the project or subcommittee) Responsibility: | Repository Name (contains documentation to be published with the upcoming release) Responsibility: | Documentation available: o repo 'branch' exists Responsibility: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
M2 | M2 | M2 | M2 | M2 | M4 | RC0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AAI | aai/aai-common | AAI Documentation Repository | Maintained | William Reehil | AAI | aai/sparky-be | Sparky - Inventory UI Service | Maintained | William Reehil | CCSDK | ccsdk/cds | CONTROLLER DESIGN STUDIO (CDS) | Maintained | Dan Timoney | CCSDK | ccsdk/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 | CPS | cps | CPS Documentation | CPS | cps/cps-tbdmt | CPS Documentation | new | CPS | cps/cps-temporal | CPS Documentation | new | CPS | cps/ncmp-dmi-plugin | CPS 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/dbcapi | DMaaP Bus Controller REST API | remove | DMAAP | dmaap/messagerouter/messageservice | dmaap/message router(MR) | maintained | DOC ArchSubCom | doc | Open Network Automation Platform | ExtAPI | externalapi/nbi | ONAP ExternalAPI / NBI | HOLMES | holmes/engine-management | Holmes | maintained | Guangrong Fu | HOLMES | holmes/rule-management | Holmes | maintained | INTEGRATION | integration | INTEGRATION | MODELING | modeling/etsicatalog | Etsicatalog Project | maintained | Yuanhong Deng | MODELING | modeling/modelspec | Model Specifications | MSB | msb/apigateway | MSB(Microservices Bus) | maintained | Jinquan Ni | MSB | msb/discovery | MSB(Microservices Bus) | maintained | MSB | msb/java-sdk | MSB(Microservices Bus) | maintained | Jinquan Ni | MULTICLOUD | multicloud/framework | MultiCloud Architecture | maintained | Bin Yang | OOM | oom | OOM Documentation Repository | OOM | oom/offline-installer | OOM offline-installer | OOM | oom/platform/cert-service | OOM Certification Service | OOF | optf/cmso | Optimization Framework: Change Management Schedule Optimization | remove | krishna moorthy | 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 | POLICY | policy/parent | Policy Framework Architecture | maintained | 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 | VID | vid | VID Documentation | 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 | VVP | vvp/documentation | VVP Documentation | maintained |
Unmaintained Repositories Table
Repo status: No change Doc status: No change |
|
| |||||
27 | MULTICLOUD | multicloud/k8s | MultiCloud Kubernetes Plugin | Minor changes expected for Jakarta |
|
| |
28 | OOM | oom | OOM Documentation Repository | no PTL since 2022-04-01 |
|
| |
29 | OOM | oom/offline-installer | OOM offline-installer | Repo status: No change Doc status: No change | 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 | Changes expected for Jakarta |
|
| |
32 | OOF | optf/osdf | Optimization Framework: Optimization Service Design Framework (OSDF) | Changes expected for Jakarta |
|
| |
33 | SECCom | osa | ONAP Security |
|
| ||
34 | POLICY | policy/parent | Policy Framework Architecture | Changes expected for Jakarta |
|
| |
35 | SDC | sdc | SDC Documentation | Minor changes for Jakarta |
|
| |
36 | SDNC | sdnc/oam | Network Controller (SDNC) | Changes expected for Jakarta |
|
| |
37 | SO | so | ONAP SO | Minor changes expected for Jakarta |
|
| |
38 | UUI | usecase-ui | Usecase-UI(Use Case User Interface) | Minor changes expected for Jakarta |
|
| |
39 | VFC | vfc/nfvo/lcm | VF-C(Virtual Function Controller) | Minor changes expected for Jakarta |
|
| |
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: | 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 | 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 |
|
| ||||||||||||||||||||
05 | VVP | vvp/documentation | VVP Documentation | unmaintained |
|
| Project Name (common abbreviation of the project or subcommittee) Responsibility: | ReadTheDocs Link (link pointing to RTD 'latest' main index.rst; main title used in index.rst) Responsibility: | |||||||||||||||||||
AAF | aaf/authz | AAF - Application Authorization Framework | Unmaintained | yes | Master | Frankfurt | AAF | aaf/certservice | Unmaintained | no | Frankfurt | AAF | aaf/sms | Unmaintained | no | Frankfurt | |||||||||||
AAI | aai/esr-gui | AAI-esr-server | Unmaintained | yes | Master | Frankfurt | |||||||||||||||||||||
AAI | aai/esr-server | AAI-esr-server | Unmaintained | yes | Master | Frankfurt | AAI | aai/event-client | Mature | no | Honolulu | ||||||||||||||||
APPC | appc | APPC Documentation Repository | Unmaintained | yes | Frankfurt | Frankfurt | |||||||||||||||||||||
APPC | appc/deployment | APPC Deployment Documentation | Unmaintained | yes | Frankfurt | Frankfurt | CCSDK | ccsdk/apps | Mature | no | Honolulu | CCSDK | ccsdk/dashboard | Mature | no | Honolulu | CCSDK | ccsdk/platform/blueprints | Mature | no | Master | CCSDK | ccsdk/platform/nbapi | Mature | no | Amsterdam | CCSDK | ccsdk/platform/plugins | Mature | no | Elalto | INTEGRATION | integration/benchmark | Incubation | no | Casablanca | INTEGRATION | integration/devtool | Incubation | no | Casablanca | INTEGRATION | integration/simulators/pnf-simulator | Incubation | no | Frankfurt |
LOGGING | logging-analytics | Logging Documentation Repository | Unmaintained | yes | Master | Elalto | LOGGING | logging-analytics/pomba/pomba-audit-common | Unmaintained | no | Elalto | MODELING | modeling/toscaparsers | Mature | no | Elalto | MSB | msb/discovery | Incubation | no | Honolulu | MSB | msb/java-sdk | Incubation | no | MSB | msb/swagger-sdk | Incubation | no | MULTICLOUD | multicloud/azure | Mature | no | MULTICLOUD | multicloud/k8s | Mature | no |
MUSIC | music | Music Developer Documentation | Unmaintained | yes | Frankfurt | Frankfurt | |||||||||||||||||||||
MUSIC | music/distributed-kv-store | Distributed KV store Documentation | Unmaintained | yes | Master | Beijing | oparent | oparent/cia | ? | no | POLICY | policy/engine | Mature | no | |||||||||||||
PORTAL | portal | Portal | Unmaintained | yes | Guilin | Guilin | |||||||||||||||||||||
SDC | sdc/sdc-distribution-client | Mature | no | SDC | sdc/sdc-docker-base | Mature | no | SDC | sdc/sdc-tosca | Mature | no | SDC | sdc/sdc-workflow-designer | Mature | no | SO | so/ | Mature | no | INTEGRATION | testsuite/pythonsdk-tests | Incubation | no | VFC | vfc/nfvo/driver/vnfm/svnfm | Mature | no |
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!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.
...
Repository Status: Please note if the repository is new, was maintained has changed or must be removed. For 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)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!