You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Tracking Table


Project Name

Document TitleRST-FileRTD-Link

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 <date>

(Document owner must attend at least one hackathon)

(fill in green checkmark (tick) if attended)

Attended Doc Hackathon 2 on <date>

(Document owner must attend at least one hackathon)

(fill in green checkmark (tick) if attended)

Link to Final Documentation in ReadTheDocs (stable/guilin 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-M4RC2

CLAMPArchitecturehttps://git.onap.org/clamp/tree/docshttps://docs.onap.org/projects/onap-clamp/en/latest/index.html#master-indexMaintainedMinor UpdateN/A




POLICYArchitecture

MaintainedMinor UpdateN/A




POLICYOffered APIs

MaintainedMinor UpdateN/A




POLICYDevelopment Guide

MaintainedMinor UpdateN/A




HOLMESArchitecture

MaintainedNo ChangeN/A




HOLMESOffered APIs

MaintainedNo ChangeN/A




HOLMESConsumed APIs

MaintainedMinor UpdateN/A




HOLMESInstallation

MaintainedMinor UpdateN/A




ModelingArchitecture

MaintainedMinor UpdateN/A




ModelingOffered APIs

MaintainedMinor UpdateN/A




OOFArchitecture

MaintainedMinor UpdateN/A




OOFOffered APIs

MaintainedMinor UpdateN/A




OOFRelease Notes

MaintainedMinor UpdateN/A




VFCOffered APIs

MaintainedMinor UpdateN/A




SOArchitecture

MaintainedMinor UpdateN/A




SOOffered APIs

MaintainedMinor UpdateN/A




SODevelopment Guide

MaintainedMinor UpdateN/A




VIDRelease Notes

MaintainedMinor UpdateN/A




VIDSwagger API

Ittay Stern , automatically generated

MaintainedNo ChangeN/A




VIDUser Guide

MaintainedNo ChangeN/A




Usecase UIRelease Notes

MaintainedMinor UpdateN/A




Usecase UIUser Guide

MaintainedMinor UpdateN/A




Usecase UIInstallation Guide

MaintainedNo ChangeN/A




SDCArchitecture

MaintainedMinor UpdateN/A




SDCRelease Notes

MaintainedMinor UpdateN/A




AAIOffered APIshttps://git.onap.org/aai/aai-common/tree/docs/platformhttps://docs.onap.org/projects/onap-aai-aai-common/en/latest/index.html#master-indexMaintainedMinor Update





AAIAAI REST APIhttps://git.onap.org/aai/aai-common/tree/docs/AAI%20REST%20API%20Documentationhttps://docs.onap.org/projects/onap-aai-aai-common/en/latest/AAI%20REST%20API%20Documentation/AAIRESTAPI.htmlMaintainedMinor Update





AAIRelease Noteshttps://git.onap.org/aai/aai-common/tree/docs/release-notes.rsthttps://docs.onap.org/projects/onap-aai-aai-common/en/latest/release-notes.htmlMaintainedMinor Update





AAIESR GUIhttps://git.onap.org/aai/esr-gui/tree/docshttps://docs.onap.org/projects/onap-aai-esr-gui/en/latest/index.html#master-index?







AAIESR Serverhttps://git.onap.org/aai/esr-server/tree/docshttps://docs.onap.org/projects/onap-aai-esr-server/en/latest/index.html#master-index








AAISparky BE Serverhttps://git.onap.org/aai/sparky-be/tree/docshttps://docs.onap.org/projects/onap-aai-sparky-be/en/latest/index.html#master-index








AAI

Event Client Documentation Repository

https://docs.onap.org/projects/onap-aai-event-client/en/latest/index.html#master-indexhttps://docs.onap.org/projects/onap-aai-event-client/en/latest/index.html#master-index








IntegrationRelease Notes

MaintainedMinor Update





IntegrationUser Guide including use case documentation

MaintainedMinor Update





IntegrationTest Developer Guide

NewInitial Publication





MultiCloudArchitecture

MaintainedNo ChangeN/A




MultiCloudRESP API

MaintainedNo ChangeN/A




MultiCloudUser Guild

MaintainedNo ChangeN/A




ONAP CLIRelease notes

MaintainedMinot updatesN/A




VNFSDK

release notes

API



MaintainedMinot updatesN/A




DCAEArchitecturehttps://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/architecture.htmlMaintainedMinor Update





DCAERelease Noteshttps://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/release-notes.htmlMaintainedMinor Update





DCAEOffered API'shttps://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/offeredapis.htmlMaintainedMinor Update





DCAEConsumed API'shttps://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/consumedapis.htmlMaintainedMinor Update





DCAE

MOD User guide

https://git.onap.org/dcaegen2/tree/docs/sections/design-components/DCAE-MODhttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/design-components/index-onboarding.htmlMaintainedMinor Update





DCAEDCAE Service Componentshttps://git.onap.org/dcaegen2/tree/docs/sections/serviceshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/services/serviceindex.htmlMaintainedMinor Update on existing components + new Guilin components





VVPVVP Documentation

MaintainedMinor UpdateN/A




VNFRQTSProvider Docs

MaintainedMinor Update





DMAAPArchitecture and Usage

MaintainedNo ChangeN/A




DMAAPRelease Notes

MaintainedMinor ChangeN/A




PORTALRelease Notes

MaintainedMajor UpdateN/A




CCSDKCDS User Guidehttps://git.onap.org/ccsdk/cds/tree/docshttps://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html#master-indexMaintainedMinor updateN/A




CCSDKRelease Noteshttps://git.onap.org/ccsdk/distribution/tree/docshttps://docs.onap.org/projects/onap-ccsdk-distribution/en/latest/release-notes.htmlMaintainedMinor updateN/A




CCSDKCommon Controller Dashboardhttps://git.onap.org/ccsdk/dashboard/tree/docshttps://docs.onap.org/projects/onap-ccsdk-dashboard/en/latest/index.html#master-index








CCSDKCCSDK Platform Pluginshttps://git.onap.org/ccsdk/platform/plugins/tree/docshttps://docs.onap.org/projects/onap-ccsdk-platform-plugins/en/latest/index.html#master-index








CCSDKCCSDK APPShttps://git.onap.org/ccsdk/apps/tree/docshttps://docs.onap.org/projects/onap-ccsdk-apps/en/latest/index.html#master-index








CCSDKORANhttps://git.onap.org/ccsdk/oran/tree/docs









SDNCOffered APIs

MaintainedMinor Update





SDNCRelease Notes

MaintainedMinor UpdateN/A




DOCRelease Noteshttps://git.onap.org/doc/tree/docs/release-notes.rsthttps://docs.onap.org/en/latest/release/index.htmlMaintainedMinor UpdateN/A




DOCLanding pagehttps://git.onap.org/doc/tree/docshttps://docs.onap.org/en/latest/index.htmlMaintainedMinor UpdateN/A




DOCComposite release notehttps://git.onap.org/doc/tree/docs/releasehttps://docs.onap.org/en/latest/release/releaserepos.html#doc-releasereposMaintainedMinor UpdateN/A




DOCONAP User Guideshttps://git.onap.org/doc/tree/docs/guides/onap-userhttps://docs.onap.org/en/latest/guides/onap-user/index.htmlMaintainedMinor UpdateN/A




DOCONAP Operation Guideshttps://git.onap.org/doc/tree/docs/guides/onap-operatorhttps://docs.onap.org/en/latest/guides/onap-operator/index.htmlMaintainedMinor UpdateN/A




DOCRST Templateshttps://git.onap.org/doc/tree/docs/templates
Sofia Wallin







DOCDOC Developer Guidehttps://git.onap.org/doc/tree/docs/guides/onap-developer/how-to-use-docshttps://docs.onap.org/en/latest/guides/onap-developer/how-to-use-docs/index.html







DOC
(ARC)
API Referencehttps://git.onap.org/doc/tree/docs/guides/onap-developer/apirefhttps://docs.onap.org/en/latest/guides/onap-developer/apiref/index.html







DOCONAP Tutorialshttps://git.onap.org/doc/tree/docs/guides/onap-developer/tutorialshttps://docs.onap.org/en/latest/guides/onap-developer/tutorials/index.html







DOCONAP Component Document Indexhttps://git.onap.org/doc/tree/docs/guides/onap-developer/developing

https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html

https://git.onap.org/doc/log/docs/conf.py









DOC
(ARC)
ONAP Architecturehttps://git.onap.org/doc/tree/docs/guides/onap-developer/architecturehttps://docs.onap.org/en/latest/guides/onap-developer/architecture/index.html







DOC
(ARC)
ONAP Overviewhttps://git.onap.org/doc/tree/docs/guides/overviewhttps://docs.onap.org/en/latest/guides/overview/index.html







OOMSetup Guide

MaintainedMinor UpdateN/A




OOMRelease Notes

MaintainedMinor UpdateN/A




EXTAPIArchitecture

MaintainedNo ChangeN/A




EXTAPIOffered APIs

MaintainedMinor UpdateN/A




EXTAPIConsumed APIs

MaintainedMinor UpdateN/A




EXTAPIInstallation

MaintainedNo ChangeN/A




EXTAPIDeveloper Guide

MaintainedNo ChangeN/A




MSBArchitecture

MaintainedNo ChangeN/A




MSBOffered APIs

MaintainedNo ChangeN/A




MSBConsumed APIs

MaintainedNo ChangeN/A




MSBInstallation

Maintained No ChangeN/A




APPCAPPC Deploymenthttps://git.onap.org/appc/deployment/tree/docshttps://docs.onap.org/projects/onap-appc-deployment/en/latest/index.html#master-index








APPCAPPC Documentationhttps://git.onap.org/appc/tree/docshttps://docs.onap.org/projects/onap-appc/en/latest/index.html#master-index








AAFApplication Authorization Frameworkhttps://git.onap.org/aaf/authz/tree/docshttps://docs.onap.org/projects/onap-aaf-authz/en/latest/index.html#master-index








AAFSecret Management Servicehttps://git.onap.org/aaf/sms/tree/docshttps://docs.onap.org/projects/onap-aaf-sms/en/latest/index.html#master-index








CLICommand Line interfacehttps://git.onap.org/cli/tree/docshttps://docs.onap.org/projects/onap-cli/en/latest/index.html#master-index























































































Procedure

M1

  1. Find JIRA task attached to M1 Epic for your project, if you haven't already done so.
  2. 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
  3. Update status of JIRA task as Done

M2/M3

  1. Find JIRA task attached to M2 Epic for your project, if you haven't already done so.
  2. 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.
  3. 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.
  4. Update the status of the JIRA task as Done.

Post M4

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

RC2

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


  • No labels