Tracking Table

Project Name	Document Title	Document Owner (name - use @ notation)	Current Document State (as of M1) Choices: New Maintained	Activity Planned for Release Choices: Initial Publication Major Update Minor Update No Change	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 if attended)	Attended Doc Hackathon 2 on March 25 (Document owner must attend at least one hackathon) (fill in green checkmark if attended)	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	Gervais-Martial Ngueko	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	Gervais-Martial Ngueko	Maintained	Minor Update	N/A			https://onap-doc.readthedocs.io/projects/onap-clamp/en/frankfurt/user-guide.html
CLAMP	Release Note	Gervais-Martial Ngueko	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			https://docs.onap.org/en/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	Bin Yang	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	Bin Yang	Maintained	No Change	N/A			https://docs.onap.org/en/frankfurt/submodules/multicloud/framework.git/docs/index.html#multicloud-plugins-user-guides		No Frankfurt Branch ! Still API V1 vesion documented
APPC	LCM API Guide	Takamune Cho	Maintained	Minor Update	N/A			https://onap-doc.readthedocs.io/projects/onap-appc/en/frankfurt/APPC-LCM-API-Guide/APPC-LCM-API-Guide.html
APPC	Client Library Guide	Takamune Cho	Maintained	Minor Update	N/A			https://docs.onap.org/en/frankfurt/submodules/appc.git/docs/APPC-Client-Library-Guide/APPC-Client-Library-Guide.html
APPC	Logging Guide	Takamune Cho	Maintained	No Change	N/A			https://docs.onap.org/en/frankfurt/submodules/appc.git/docs/APPC-Logging-Guide/APPC-Logging-Guide.html
APPC	User Guide	Takamune Cho	Maintained	Minor Update	N/A			https://docs.onap.org/en/frankfurt/submodules/appc.git/docs/APPC-User-Guide/APPC-User-Guide.html
APPC	OAM API Guide	Takamune Cho	Maintained	No Change	N/A			https://docs.onap.org/en/frankfurt/submodules/appc.git/docs/APPC-OAM-API-Guide/APPC-OAM-API-Guide.html
APPC	CDT User Guide	Takamune Cho	Maintained	Minor Update	N/A			https://docs.onap.org/en/frankfurt/submodules/appc.git/docs/APPC-CTD-Guide/APPC-CDT-Guide.html
PORTAL	Release Notes	Lorraine A. Welch	Maintained	Minor Update	N/A			RC0
INTEGRATION	User Guide	Morgan Richomme	Maintained	Minor update	N/A			https://docs.onap.org/en/frankfurt/submodules/integration.git/docs/index.html?highlight=integration
INTEGRATION	CI Guide	Morgan Richomme	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	Pamela Dragosh	Maintained	Minor Update	N/A			https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/frankfurt/architecture/architecture.html
POLICY	Offered APIs	Pamela Dragosh	Maintained	Minor Update	N/A			https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/frankfurt/offeredapis.html
POLICY	Development Guide	Pamela Dragosh	Maintained	Minor Update	N/A			https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/frankfurt/development/development.html
EXTAPI	Architecture	Adrian OSullivan	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	`nbicallflow.pdf` 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	Adrian OSullivan	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	Adrian OSullivan	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	Former user (Deleted)	Maintained	No Change	N/A			https://docs.onap.org/en/latest/submodules/vnfsdk/model.git/docs/files/vnf-test-platform.html	https://docs.onap.org/en/frankfurt/submodules/vnfsdk/model.git/docs/files/vnf-test-platform.html
VNFSDK	Marketplace/VTP API	Former user (Deleted)	Maintained	No Change	N/A			https://docs.onap.org/en/latest/submodules/vnfsdk/model.git/docs/files/marketplace-overview.html	https://docs.onap.org/en/frankfurt/submodules/vnfsdk/model.git/docs/files/marketplace-overview.html
VNFSDK	User Guide	Former user (Deleted)	Maintained	No Change	N/A			https://docs.onap.org/en/latest/submodules/vnfsdk/model.git/docs/index.html#user-guides	https://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/frankfurt/sections/offeredapis.html
OOM	Setup Guide	Sylvain Desbureaux	Maintained	Minor update	N/A				https://onap-doc.readthedocs.io/projects/onap-oom/en/latest/index.html#master-index
OOM	Release Notes	Sylvain Desbureaux	Maintained	Minor update	N/A
VF-C	Offered APIs	Yan Yang	Maintained	Minor update	N/A			https://onap.readthedocs.io/en/frankfurt/submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.html
VF-C	User Guide	Yan Yang	Maintained	Minor update	N/A			https://onap.readthedocs.io/en/frankfurt /submodules/vfc/nfvo/lcm.git/docs/platform/installation/user-guide/ns-instantiate-guide.html
VF-C	Installation Guide	Yan Yang	Maintained	Minor update	N/A			https://onap.readthedocs.io/en/frankfurt /submodules/vfc/nfvo/lcm.git/docs/platform/installation/index.html
CCSDK	CDS User Guide	Yuriy Malakov	Maintained	Minor update	N/A			https://docs.onap.org/en/frankfurt/submodules/ccsdk/cds.git/docs/index.html
CCSDK	Release Notes	Dan Timoney	Maintained	Minor update	N/A			https://onap-doc.readthedocs.io/projects/onap-ccsdk-distribution/en/frankfurt/release-notes.html
CLI	Release Notes	Former user (Deleted)	Maintained	Minor Update	N/A
VVP	VNF Validation Documentation	steven stark	Maintained	Minor update	NA	NA	NA	VNF Validation Documentation
VNFRQTS	VNF and PNF Requirements and Guidelines	Trevor Lovett	Maintained	Minor Update	NA	NA	NA	VNF and PNF Requirements and Guidelines
AAI	Offered APIs	James Forsyth	Maintained	Minor Update	N/A			https://onap-doc.readthedocs.io/projects/onap-aai-aai-common/en/frankfurt/platform/offeredapis.html
AAI	AAI REST API	James Forsyth	Maintained	Minor Update	N/A			AAI REST API Documentation - Frankfurt
AAI	Release Notes	James Forsyth	Maintained	Minor Update	N/A			https://onap-doc.readthedocs.io/projects/onap-aai-aai-common/en/frankfurt/release-notes.html
MUSIC	Architecture and Usage	bharathb	Maintained	Minor Update	N/A	N/A	N/A	https://onap-doc.readthedocs.io/projects/onap-music/en/frankfurt/release-notes.html		release date need to be updated
SDNC	Offered APIs	Dan Timoney	Maintained	Minor Update	N/A			https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/offeredapis.html
SDNC	Release Notes	Dan Timoney	Maintained	Minor Update	N/A			https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/release-notes.html
DCAE	Architecture	Vijay Kumar	Maintained	Minor Update				https://docs.onap.org/en/frankfurt /submodules/dcaegen2.git/docs/sections/architecture.html
DCAE	Release Notes	Vijay Kumar	Maintained	Minor Update				https://docs.onap.org/en/frankfurt/submodules/dcaegen2.git/docs/sections/release-notes.html
DCAE	Offered API's	Vijay Kumar	Maintained	Minor Update	https://gerrit.onap.org/r/#/c/dcaegen2/+/100354/			https://docs.onap.org/en/frankfurt /submodules/dcaegen2.git/docs/sections/offeredapis.html
DCAE	Consumed API's	Vijay Kumar	Maintained	Minor Update				https://docs.onap.org/en/frankfurt/submodules/dcaegen2.git/docs/sections/consumedapis.html
DCAE	MOD User guide	Deven Vijay Kumar	New	Initial publication	Placeholder - DCAE MOD User Guide			https://docs.onap.org/en/frankfurt/submodules/dcaegen2.git/docs/sections/design-components/DCAE-MOD/DCAE-MOD-User-Guide.html
DCAE	DCAE Service Components	Vijay Kumar	Maintained	Minor Update	PMSH - https://gerrit.onap.org/r/#/c/dcaegen2/+/98979/			https://docs.onap.org/en/frankfurt/submodules/dcaegen2.git/docs/sections/services/pm-subscription-handler/index.html
DCAE	Acumos Adapter	Andrew Gauld Vijay Kumar	New	Initial publication	Placeholder - Acumos DCAE Integration			As this is POC, documentation will be maintained on WIKI Acumos Adapter Installation Acumos DCAE Integration
DMAAP	Architecture and Usage	Mandar Sawant	Maintained	No Change				Data Router Bus Controller Message Router
DMAAP	Release Notes	Mandar Sawant	Maintained	Minor Change				Data Router Bus Controller Message Router
VID	Release Notes	ittay	Maintained	Minor Update	n/a			https://docs.onap.org/en/frankfurt/submodules/vid.git/docs/release-notes.html
VID	Swagger API	ittay , automatically generated	Maintained	No Change	n/a
VID	User Guide	ittay	Maintained	No Change	n/a			https://docs.onap.org/en/frankfurt/submodules/vid.git/docs/humaninterfaces.html
AAF	WIKI	Jonathan Gathman	Maintained	Admin/Release	Application Authorization Framework (AAF) Documentation
AAF	Main Docs	Jonathan Gathman	Maintained	Improve (link to Swagger?)/Add new Feature info.	AAF Read-the-Docs			AAF Read-the-Docs
AAF	API Docs	Jonathan Gathman	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			https://docs.onap.org/en/frankfurt/submodules/usecase-ui.git/docs/release-notes.html
Usecase-UI	User Guide	xu ran	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	xu ran	Maintained	Minor Update	N/A			https://docs.onap.org/en/frankfurt/submodules/usecase-ui.git/docs/platform/installation/installation/index.html

SDC	Delivery	Ofir Sonsino	Maintained	Minor update	N/A			https://docs.onap.org/en/frankfurt/submodules/sdc.git/docs/index.html
Holmes	Release Notes	Guangrong Fu	Maintained	Minor update	N/A
Holmes	User Guide	Guangrong Fu	Maintained	Minor update	N/A
Holmes	Architecture	Guangrong Fu	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

M2/M3

Find JIRA task attached to M2 Epic for your project, if you haven't already done so.
Note that this task applies to new documents only (i.e., "New" in Current Document State column). If this is not a new document, just enter "N/A" in the Preliminary Documentation Completed column in the table above.
For new documents, at a minimum create a placeholder document (e.g., document with a title, or an outline), and commit to the repo. Add a link to the gerrit to the Preliminary Documentation column in the table above.
Update the status of the JIRA task as Done.

Post M4

Find the dates for the two documentation hackathons.
The document owner should plan on attending at least one of the two hackathons.
Enter a green checkmark in the appropriate column in the table above for the hackathon that was attended.

RC0

Find JIRA task attached to RC0 Epic for your project, if you haven't already done so.
Add a link to the document in ReadTheDocs in the appropriate column in the table above.
Update the status of the JIRA task as Done.

Browser not supported