London Documentation
IMPORTANT NOTE Beginning with the 'Jakarta' release a project/repository contributing to the documentation of the release needs to ...
|
---|
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) ( see also History of PTL ) Responsibility: | Documentation available: (relevant for new repos which are participating the first time) docs config up-to-date Responsibility: | Documentation available: repo 'branch' exists Responsibility: |
---|---|---|---|---|---|---|---|
M2 | M2 | M2 | M2 | M2 | M4 | RC0 | |
01 | AAI | aai/aai-common | AAI Documentation Repository | no PTL since 2022-12-02 | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
02 | AAI | aai/sparky-be | Sparky - Inventory UI Service | no PTL since 2022-12-02 | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated (aai/aai-common) | |
03 | CCSDK | ccsdk/apps | CCSDK APPS DOCUMENTATION REPOSITORY | no updates | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated (ccsdk/distribution) | |
04 | CCSDK | ccsdk/cds | CONTROLLER DESIGN STUDIO (CDS) | changed | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated (ccsdk/distribution) | |
05 | CCSDK | ccsdk/distribution | Common Controller Software Development Kit | changed | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
06 | CCSDK | ccsdk/features | SDN-R Online help | changed | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated (ccsdk/distribution) | |
07 | CCSDK | ccsdk/oran | ccsdk/oran | changed | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
08 | CLI | cli | ONAP CLI | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | ||
09 | CPS | cps | CPS Documentation | no updates | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
10 | CPS | cps/cps-temporal | CPS Temporal | no updates | According to Toine Siebelink the project is no longer maintained. To be removed? | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated |
11 | CPS | cps/ncmp-dmi-plugin | DMI-Plugin Documentation | no updates | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
12 | DCAE | dcaegen2 | Data Collection Analytics and Events (DCAE) | DCAE Mod retired (no change in root documentation repo) | no PTL since 2022-12-01 | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated |
13 | DMAAP | dmaap/buscontroller | dmaap/buscontroller | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | ||
14 | DMAAP | dmaap/datarouter | DMaaP Data Router | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | ||
15 | DMAAP | dmaap/messagerouter/messageservice | dmaap/message router(MR) | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | ||
16 | DOC ArchSubCom | doc | Open Network Automation Platform | Architecture Updates | docs config up-to-date repo 'master' exists 'latest' available in RTD Architecture updated | repo branched 'branch' available in RTD release notes (doc) available in RTD and updated release notes (composite) available in RTD and updated Architecture updated | |
17 | HOLMES | holmes/engine-management | Holmes | no updates | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated (holmes/rule-management) | |
18 | HOLMES | holmes/rule-management | Holmes | no updates | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
19 | INTEGRATION | integration | INTEGRATION | no PTL since 2022-06-30 | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
20 | MODELING | modeling/etsicatalog | Etsicatalog Project | no updates | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
21 | MODELING | modeling/modelspec | Model Specifications | no updates | docs config up-to-date repo 'master' exists 'latest' available in RTD | ||
22 | MSB | msb/apigateway | MSB(Microservices Bus) | no updates | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
23 | MSB | msb/swagger-sdk | Swagger SDK | no updates | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated (msb/apigateway) | |
24 | MULTICLOUD | multicloud/framework | MultiCloud Architecture | stepping down as PTL 2023-04-24 | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
25 | MULTICLOUD | multicloud/k8s | MultiCloud Kubernetes Plugin | stepping down as PTL 2023-04-24 | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated (multicloud/framework) | |
26 | OOM | oom | OOM Documentation Repository | changed: will be updated to reflect the London changes (ServiceMesh, AAF removal, Ingress) | no PTL since 2022-04-01 | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated |
27 | OOF | optf/has | Optimization Framework: Homing and Allocation | no PTL since 2022-10-07 | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
28 | OOF | optf/osdf | Optimization Framework: Optimization Service Design Framework (OSDF) | no PTL since 2022-10-07 | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
29 | POLICY | policy/parent | Policy Framework Architecture | No updates | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
30 | Portal-NG | portal-ng | Portal-NG | POC - currently no docs available | Georg Schweflinghaus | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated |
31 | SECCom | osa | ONAP Security | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | ||
32 | SDC | sdc | SDC Documentation | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | ||
33 | SDNC | sdnc/oam | Network Controller (SDNC) | changed | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
34 | SO | so | ONAP SO | General platform update Architecture | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and update | |
35 | UUI | usecase-ui | Usecase-UI(Use Case User Interface) | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | ||
36 | VFC | vfc/nfvo/lcm | VF-C(Virtual Function Controller) | no PTL since 22-12-05 | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
37 | VNFSDK | vnfsdk/model | VNFSDK Documentation | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and 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: | Documentation available: (relevant for new repos which are participating the first time) repo 'master' exists Responsibility: | Documentation available: repo 'branch' exists 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 | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes (ChangeLog) available in RTD and updated | |
02 | oom/platform/cert-service | OOM Certification Service | remove: will not be needed, as AAF will be removed | no PTL since 2022-04-01 | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated | |
03 | MSB | msb/discovery | MSB(Microservices Bus) | no updates | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated (msb/apigateway) | |
04 | MSB | msb/java-sdk | MSB(Microservices Bus) | no updates | docs config up-to-date repo 'master' exists 'latest' available in RTD | repo branched 'branch' available in RTD release notes available in RTD and updated (msb/apigateway) | |
00 | |||||||
00 | |||||||
00 |
Notes for "Maintained Repositories"
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: Link pointing to RTD 'latest' main index.rst. Main title used in index.rst.
Repository Status: Please note if the repository is new, has changed 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)