| Table of Contents |
|---|
Short Explanation
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).
Unmaintained 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
Unmaintained Repositories Table
Project Name (common abbreviation of the project or subcommittee) Responsibility: | Repository Name (may contain documentation to be published with the upcoming release)
| ReadTheDocs Link (link pointing to RTD 'latest' main index.rst; main title used in index.rst) Responsibility: | Project Lifecycle State (ONAP Dev Wiki)
| Docs In This Repo Are Part Of The Upcoming Release Responsibility: | Name of Branch Used In The Upcoming Release Responsibility: | Name of Latest Available Branch
|
|---|---|---|---|---|---|---|
| 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
We as the doc team are responsible for providing the right set of documentation specific for every ONAP release. This release-specific set of documentation always consists of a large number of text files, formatted in the restructuredText markup language and spread over a large number of repositories. The documentation files are interlinked by the doc team using intersphinx linking functionality and config files residing in the branched doc repo. The documentation is build automatically and can be found in ReadTheDocs by choosing the respective release name. Some numbers for the Guilin release may show the scale:
...
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.
Notes for "Maintained Repositories"
In the table "Maintained Repositories" please check/update:
...