Tables shown below
Maintained Repositories
- containing documentation repositories for the upcoming release
- Maintained commonly by the ONAP projects and the Documentation team.
- In the column header you find the responsibility for this column (DOC|PROJECT).Unmaintained Repositories
- existing repositories containing documents,
- which are belonging to an active project, but not used in the ONAP documentation
- which are belnging to an unmaintained project, but used in the ONAP documentation
- could be "reactivated" by the ONAP project in the upcoming release
- Maintained by DOC only
The DOC project maintains a "Master" list of the tables below in MASTER Documentation Tracking Page
Procedure
M2
- Find JIRA task attached to M2 Epic for your project, if you haven't already done so.
- In the table Maintained Repositories below, 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: Pointing to RTD 'latest'!
- Content: 'Categories' of the provided documentation.
- Repository Status: Please note if the repository is new, was maintained 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)
- Check the the table Unmaintained Repositories and move repositories to the upper table, if the repository is maintained in the target release
- Update status of JIRA task as Done
M4
- Find JIRA task attached to M4 Epic for your project, if you haven't already done so.
- Update the status of the JIRA task as Done.
RCx
- Find JIRA task attached to RC2 Epic for your project, if you haven't already done so.
- Update the status of the JIRA task as Done.
Maintained Repositories
Unmaintained Repositories
Project Name (common abbreviation of the project or subcommittee) DOC | Project Lifecycle State (Source?) DOC | Repository Name (may contain documentation to be published with the upcoming release) DOC | ReadTheDocs Link (pointing to RTD latest) DOC | Docs In This Repo Are Part Of The Upcoming Release DOC | Branch Used In The Upcoming Release DOC | Latest Available Branch DOC |
---|---|---|---|---|---|---|
AAF | Unmaintained | aaf/authz | AAF Architecture, APIs and Guides | yes | Master | Frankfurt |
AAF | Unmaintained | aaf/certservice | no | Frankfurt | ||
AAF | Unmaintained | aaf/sms | no | Frankfurt | ||
AAI | Unmaintained | aai/esr-gui | External System Registry GUI Documentation | yes | Master | Frankfurt |
AAI | Unmaintained | aai/esr-server | External System Registry Server Documentation | yes | Master | Frankfurt |
AAI | Mature | aai/event-client | no | Honolulu | ||
APPC | Unmaintained | appc | APPC Architecture, APIs and Guides | yes | Frankfurt | Frankfurt |
APPC | Unmaintained | appc/deployment | APPC Deployment Documentation | yes | Frankfurt | Frankfurt |
CCSDK | Mature | ccsdk/apps | no | Honolulu | ||
CCSDK | Mature | ccsdk/dashboard | no | Honolulu | ||
CCSDK | Mature | ccsdk/platform/blueprints | no | Master | ||
CCSDK | Mature | ccsdk/platform/nbapi | no | Amsterdam | ||
CCSDK | Mature | ccsdk/platform/plugins | no | Elalto | ||
INTEGRATION | Incubation | integration/benchmark | no | Casablanca | ||
INTEGRATION | Incubation | integration/devtool | no | Casablanca | ||
INTEGRATION | Incubation | integration/simulators/pnf-simulator | no | Frankfurt | ||
LOGGING | Unmaintained | logging-analytics | ONAP Centralized Logging Documentation | yes | Master | Elalto |
LOGGING | Unmaintained | logging-analytics/pomba/pomba-audit-common | no | Elalto | ||
MODELING | Mature | modeling/toscaparsers | no | Elalto | ||
MSB | Incubation | msb/discovery | no | Honolulu | ||
MSB | Incubation | msb/java-sdk | no | |||
MSB | Incubation | msb/swagger-sdk | no | |||
MULTICLOUD | Mature | multicloud/azure | no | |||
MULTICLOUD | Mature | multicloud/k8s | no | |||
MUSIC | Unmaintained | music | MUSIC Architecture and Guides | yes | Frankfurt | Frankfurt |
MUSIC | Unmaintained | music/distributed-kv-store | MUSIC Distribute KV Store Documents | yes | Master | Beijing |
oparent | ? | oparent/cia | no | |||
POLICY | Mature | policy/engine | no | |||
PORTAL | Unmaintained | portal | ONAP Portal Platform Documentation | yes | Guilin | Guilin |
SDC | Mature | sdc/sdc-distribution-client | no | |||
SDC | Mature | sdc/sdc-docker-base | no | |||
SDC | Mature | sdc/sdc-tosca | no | |||
SDC | Mature | sdc/sdc-workflow-designer | no | |||
SO | Mature | so/libs | no | |||
INTEGRATION | Incubation | testsuite/pythonsdk-tests | no | |||
VFC | Mature | vfc/nfvo/driver/vnfm/svnfm | no |