Oslo Documentation
- Byung-Woo Jun
- Thomas Kulik
TABLE OF CONTENTS
**** Work in Progress for Oslo ****
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
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: | Core Project (is the project a core component of ONAP?) | 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: |
|---|---|---|---|---|---|---|---|---|
| RC0 | ||||||||
| 01 | AAI | aai/aai-common | AAI Documentation Repository | yes | no PTL since 2022-12-02 |
|
| |
| 02 | AAI | aai/sparky-be | Sparky - Inventory UI Service | yes | no PTL since 2022-12-02 |
|
| |
| 03 | CCSDK | ccsdk/apps | CCSDK APPS DOCUMENTATION REPOSITORY | yes as an ONAP common shared utility
|
|
| ||
| 04 | CCSDK | ccsdk/cds | CONTROLLER DESIGN STUDIO (CDS) | yes as an ONAP common shared utility for:
|
|
| ||
| 05 | CCSDK | ccsdk/distribution | Common Controller Software Development Kit | yes as an ONAP common shared utility for:
|
|
| ||
| 06 | CCSDK | ccsdk/features | SDN-R Online help | yes as an ONAP common shared utility for:
|
|
| ||
| 07 | CCSDK | ccsdk/oran | ccsdk/oran | yes as an ONAP common shared utility for:
|
|
| ||
| 08 | CPS | cps | CPS Documentation | yes |
|
| ||
| 09 | CPS | cps/ncmp-dmi-plugin | DMI-Plugin Documentation | yes |
|
| ||
| 10 | DCAE | dcaegen2 | Data Collection Analytics and Events (DCAE) | yes | no PTL since 2022-12-01 |
|
| |
| 11 | DOC | doc | Open Network Automation Platform | to be defined | Thomas Kulik (doc) |
|
| |
| 12 | ARCCOM | doc | ONAP Architecture | Yes; it is a committee and defining over ONAP architecture |
|
| ||
| 13 | INTEGRATION | integration | INTEGRATION | to be defined | Marek Szwałkiewicz |
|
| |
| 14 | MULTICLOUD | multicloud/framework | MultiCloud Architecture | to be defined | no PTL since 2023-04-24 |
|
| |
| 15 | MULTICLOUD | multicloud/k8s | MultiCloud Kubernetes Plugin | to be defined | no PTL since 2023-04-24 |
|
| |
| 16 | OOM | oom | OOM Documentation Repository | yes for:
|
|
| ||
| 17 | POLICY | policy/parent | Policy Framework Architecture | yes |
|
| ||
| 18 | Portal-NG | portal-ng/ui | Portal-NG | yes |
|
| ||
| 19 | SECCom | osa | ONAP Security | yes; note: it is a committee and the security functions are implemented as part of OOM) |
|
| ||
| 20 | SDC | sdc | SDC Documentation | to be defined | no PTL since 2024-01-16 |
|
| |
| 21 | SDNC | sdnc/oam | Network Controller (SDNC) | yes |
|
| ||
| 22 | SO | so | ONAP SO | yes |
|
| ||
| 23 | UUI | usecase-ui | Usecase-UI(Use Case User Interface) | yes |
|
|
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: | Core Project (is the project a core component of ONAP?) | 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: |
|---|---|---|---|---|---|---|---|---|
| RC0 | ||||||||
| VFC | vfc/nfvo/lcm | VF-C(Virtual Function Controller) | no PTL since 22-12-05 DEPRECATED |
|
| |||
| VNFSDK | vnfsdk/model | VNFSDK Documentation | DEPRECATED |
|
| |||
| OOF [CORE PROJECT] | optf/has | Optimization Framework: Homing and Allocation | no PTL since 2022-10-07 DEPRECATED |
|
| |||
| OOF [CORE PROJECT] | optf/osdf | Optimization Framework: Optimization Service Design Framework (OSDF) | no PTL since 2022-10-07 DEPRECATED |
|
| |||
| MODELING | modeling/etsicatalog | Etsicatalog Project | to be moved under SO? | DEPRECATED |
|
| ||
| MODELING | modeling/modelspec | Model Specifications | DEPRECATED |
| ||||
|
| |||||||
| HOLMES | holmes/rule-management | Holmes | DEPRECATED |
|
| |||
| DMAAP | dmaap/buscontroller | dmaap/buscontroller |
|
| ||||
| DMAAP | dmaap/datarouter | DMaaP Data Router |
|
| ||||
| DMAAP | dmaap/messagerouter/messageservice | dmaap/message router(MR) |
|
| ||||
| CLI | cli | ONAP CLI | DEPRECATED |
|
| |||
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)