| Table of Contents |
|---|
Tracking Table
Project Name | Document Title | Document Owner (name - use @ notation) | Current Document State (as of M1) Choices:
| Activity Planned for Release Choices:
| Preliminary Documentation New docs or new projects ONLY (enter "N/A" if not applicable, or link to gerrit if completed) | Attended Doc Hackathon 1 on March 11 (Document owner must attend at least one hackathon) (fill in green checkmark | Attended Doc Hackathon 2 on March 25 (Document owner must attend at least one hackathon) (fill in green checkmark | Link to Final Documentation in ReadTheDocs (stable/frankfurt branch) | Reviewed by the doc project (reviewed means release related content. Such as release notes and release name were applicable) By best effort! | |
|---|---|---|---|---|---|---|---|---|---|---|
M1 | M2/M3 | Post-M4 | RC0 | RC2 | ||||||
| CLAMP | Architecture | Maintained | Minor Update | N/A | https://docs.onap.org/en/frankfurt/guides/onap-developer/architecture/onap-architecture.html#closed-control-loop-automation | |||||
| CLAMP | User Guide | Maintained | Minor Update | N/A | https://onap-doc.readthedocs.io/projects/onap-clamp/en/frankfurt/user-guide.html | |||||
| CLAMP | Release Note | Maintained | Major Update | N/A | https://onap-doc.readthedocs.io/projects/onap-clamp/en/frankfurt/release-notes.html#release-notes | Release date need to be updated | ||||
| Modeling | Model Spec | Xu Yang | Maintained | Minor Update | N/A | https://docs.onap.org/en/ | ||||
| frankfurt/submodules/modeling/modelspec.git/docs/index.html | Still reference to Dublin No Frankfurt branch | |||||||
| Modeling | ETSI Catalog | Yuanhong Deng | Maintained | Minor Update | N/A |  |
frankfurt/submodules/modeling/etsicatalog.git/docs/index.html | OK, with RST file in gerrit, but pb with Frankfurt link: https://docs.onap.org/en/frankfurt/submodules/modeling/etsicatalog.git/docs/index.html | |||||||
| MultiCloud | Architecture | Maintained | No Change | N/A | https://docs.onap.org/en/ |
| frankfurt/submodules/multicloud/framework.git/docs/MultiCloud-Architecture.html | No Frankfurt Branch ! Still API V1 vesion documented | |||||||
| MultiCloud | User Guide | Maintained | No Change | N/A | https://docs.onap.org/en/ |
 | | RC0 | ||||||||
| INTEGRATION | User Guide | Maintained | Minor update | N/A | | | https://docs.onap.org/en/frankfurt/submodules/integration.git/docs/index.html?highlight=integration | |||
| INTEGRATION | CI Guide | New | Initial publication | see OOM Gating and https://wiki.opnfv.org/pages/viewpage.action?pageId=32015004 | | | https://docs.onap |
| . |
| org/ |
| en/frankfurt/submodules/integration.git/docs/onap-integration |
| -ci.html | ||||||||
| POLICY | Architecture | Maintained | Minor Update | N/A | https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/ |
| frankfurt/architecture/architecture.html | ||||||||
| POLICY | Offered APIs | Maintained | Minor Update | N/A | https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/ |
| frankfurt/offeredapis.html | ||||||||
| POLICY | Development Guide | Maintained | Minor Update | N/A | https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/ |
| frankfurt/development/development.html | ||||||||
| EXTAPI | Architecture | Maintained | No Change | N/A | https://onap.readthedocs.io/en/ |
| frankfurt/submodules/externalapi/nbi.git/docs/architecture/architecture.html | https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/architecture.html | to be updated Adrian OSullivan : API flow/examples now covered in swagger markup examples in offeredapis | ||||||
| EXTAPI | Offered APIs | Adrian OSullivan | Maintained | Minor Update | N/A | https://docs.onap. |
| org/en/ |
| frankfurt/submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.html | https://docs.onap.org/en/frankfurt/submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.html | Question: API version still v4 ? Adrian OSullivan : Yes, no major API change, so still v4 Still reference to El |
Alto Adrian OSullivan : cherry picked /updated on frankfurt branch | ||||||||
| EXTAPI | Consumed APIs | Adrian OSullivan | Maintained | Minor Update | N/A | https://onap.readthedocs.io/en/ |
| frankfurt/submodules/externalapi/nbi.git/docs/consumedapis/consumedapis.html | https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/consumedapis/consumedapis.html | Check API vesrions used for other componntes: AAI, SO, DMAAP Adrian OSullivan : checked and valid | ||||||
| EXTAPI | Developer Guide | Maintained | Minor Update | N/A | https://onap.readthedocs.io/en/ |
| frankfurt/submodules/externalapi/nbi.git/docs/architecture/NBI_Developer_Guide.html | https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/NBI_Developer_Guide.html | Link to http, no https - http still supported locally | ||||||
| EXTAPI | Installation | Maintained | Minor Update | N/A | https://onap.readthedocs.io/en/ |
| frankfurt/submodules/externalapi/nbi.git/docs/installation/installation.html | https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/installation/installation.html | Still http Adrian OSullivan when running and testing local docker it is http, https only for OOM install v4 ok ? Adrian OSullivan Yes | |||
| VNFSDK | Architecture | Maintained | No Change | N/A |
| docs.onap.org/en/frankfurt/submodules/vnfsdk/model.git/docs/index. |
| html#user- |
| guides | ||||||||||
| SO | API | Seshu Kumar Mudiganti | Maintained | Minor Update | N/A | https://onap-doc.readthedocs.io/projects/onap-so/en/frankfurt/api/offered_consumed_apis.html | ||||
| SO | Architecture | Seshu Kumar Mudiganti | Maintained | Minor Update | N/A | https://docs.onap.org/en/frankfurt/submodules/so.git/docs/architecture/architecture.html | ||||
| OOF | Architecture | Shankaranarayanan Puzhavakath Narayanan | Maintained | Minor update | N/A | https://onap-doc.readthedocs.io/projects/onap-optf-osdf/en/ |
| frankfurt/sections/architecture.html | ||||||||
| OOF | Homing Specification Guide | Shankaranarayanan Puzhavakath Narayanan | Maintained | Minor update | N/A | https://onap-doc.readthedocs.io/projects/onap-optf-has/en/ |
| frankfurt/sections/homingspecification.html | ||||||||
| OOF | API | Shankaranarayanan Puzhavakath Narayanan | Maintained | Minor update | N/A | https://onap-doc.readthedocs.io/projects/onap-optf-osdf/en/ |
| AAI REST API | Maintained | Minor Update | N/A | |
| AAI REST API |
| Framework (AAF) Documentation | ||||||||||
| AAF | Main Docs | Maintained | Improve (link to Swagger?)/Add new Feature info. | AAF Read-the-Docs | AAF Read-the-Docs | |||||
| AAF | API Docs | Maintained | Move content to Swagger in Frankfurt | AAF API Docs has always been a code-generated part of the AAF GUI. The intention for Frankfurt is to take the Code Generation element existing, and generate Swagger. | See any AAF GUI. | |||||
| Usecase-UI | Release Notes | xu ran | Maintained | Major Update | N/A |
| Usecase-UI |
| User Guide | Maintained | Minor Update | N/A | | https://docs.onap. |
| org/en/ |
| frankfurt/submodules/usecase-ui.git/docs/platform/installation/ |
| user-guide/index.html |
| Usecase-UI | Installation Guide | Maintained |
| Minor Update | N/A | https://docs.onap. |
| org/en/ |
| frankfurt/submodules/ |
| usecase-ui.git/docs/platform/installation/installation/index.html | ||||||||||
| SDC | Delivery | Maintained | Minor update | N/A | https://docs.onap. |
| org/en/ |
| frankfurt/submodules/sdc.git/docs/index.html | ||||||||||
| Holmes | Release Notes | Maintained | Minor update | N/A | ||||||
| Holmes | User Guide | Guangrong Fu | Maintained | Minor update | N/A | |||||
| Holmes | Architecture | Maintained | Minor update | N/A | ||||||
| MSB | Release Notes | Huabing Zhao | Maintained | Minor update | N/A | https://docs.onap.org/en/frankfurt/submodules/msb/apigateway.git/docs/release-notes.html | | |||
| MSB | User Guide | Huabing Zhao | Maintained | Minor update | N/A | https://docs.onap.org/en/frankfurt/submodules/msb/apigateway.git/docs/platform/user-guide.html | | |||
| MSB | Architecture | Huabing Zhao | Maintained | Minor update | N/A | https://docs.onap.org/en/frankfurt/submodules/msb/apigateway.git/docs/platform/architecture.html |
Procedure
M1
- Find JIRA task attached to M1 Epic for your project, if you haven't already done so.
- In the table above, fill in
- project name
- doc title,
- doc owner (use Confluence @ notation for name, e.g., David McBride)
- current doc state
- activity planned for release
- Update status of JIRA task as Done
...