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

Compare with Current View Page History

« Previous Version 4 Next »

Tracking Table


Project Name

Document TitlePart of
Guilin
RST-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

CLAMPArchitecture(tick)https://git.onap.org/clamp/tree/docshttps://docs.onap.org/projects/onap-clamp/en/latest/index.html#master-indexMaintainedMinor UpdateN/A




POLICYArchitecture(tick)

MaintainedMinor UpdateN/A




POLICYOffered APIs(tick)

MaintainedMinor UpdateN/A




POLICYDevelopment Guide(tick)

MaintainedMinor UpdateN/A




HOLMESArchitecture(tick)https://git.onap.org/holmes/rule-management/tree/docs/platform/architecture.rsthttps://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/architecture.htmlMaintainedNo ChangeN/A




HOLMESOffered APIs(tick)https://git.onap.org/holmes/rule-management/tree/docs/platform/offeredapis.rsthttps://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/offeredapis.htmlMaintainedNo ChangeN/A




HOLMESConsumed APIs(tick)https://git.onap.org/holmes/rule-management/tree/docs/platform/consumedapis.rsthttps://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/consumedapis.htmlMaintainedMinor UpdateN/A




HOLMESInstallation(tick)https://git.onap.org/holmes/rule-management/tree/docs/platform/installation.rsthttps://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/installation.htmlMaintainedMinor UpdateN/A




HOLMESRelease Notes(tick)https://git.onap.org/holmes/rule-management/tree/docs/release-notes.rsthttps://docs.onap.org/projects/onap-holmes-rule-management/en/latest/release-notes.html








HOLMESEngine Management?https://git.onap.org/holmes/engine-management/tree/docshttps://docs.onap.org/projects/onap-holmes-engine-management/en/latest/index.html#master-index








ModelingEtsiCatalog
Architecture
(tick)https://git.onap.org/modeling/etsicatalog/tree/docs/architecture.rsthttps://docs.onap.org/projects/onap-modeling-etsicatalog/en/latest/architecture.htmlMaintainedMinor UpdateN/A




ModelingEtsiCatalog
Offered APIs
(tick)https://git.onap.org/modeling/etsicatalog/tree/docs/offeredapis.rsthttps://docs.onap.org/projects/onap-modeling-etsicatalog/en/latest/offeredapis.htmlMaintainedMinor UpdateN/A




ModelingEtsiCatalog
Release Notes
(tick)https://git.onap.org/modeling/etsicatalog/tree/docs/release-notes.rsthttps://docs.onap.org/projects/onap-modeling-etsicatalog/en/latest/release-notes.html








ModellingModelling Specifications(tick)https://git.onap.org/modeling/modelspec/tree/docshttps://docs.onap.org/projects/onap-modeling-modelspec/en/latest/ONAP%20Model%20Spec/index.htmlModelling SC







Modelling Release Notes(tick)https://git.onap.org/modeling/modelspec/tree/docs/Release-noteshttps://docs.onap.org/projects/onap-modeling-modelspec/en/latest/Release-notes/release-notes.htmlModelling SC







OOFArchitecture(tick)

MaintainedMinor UpdateN/A




OOFOffered APIs(tick)

MaintainedMinor UpdateN/A




OOFRelease Notes(tick)

MaintainedMinor UpdateN/A




VFCOffered APIs(tick)

MaintainedMinor UpdateN/A




SOArchitecture(tick)

MaintainedMinor UpdateN/A




SOOffered APIs(tick)

MaintainedMinor UpdateN/A




SODevelopment Guide(tick)

MaintainedMinor UpdateN/A




VIDRelease Notes(tick)

MaintainedMinor UpdateN/A




VIDSwagger API(tick)

Ittay Stern , automatically generated

MaintainedNo ChangeN/A




VIDUser Guide(tick)

MaintainedNo ChangeN/A




Usecase UIRelease Notes(tick)

MaintainedMinor UpdateN/A




Usecase UIUser Guide(tick)

MaintainedMinor UpdateN/A




Usecase UIInstallation Guide(tick)

MaintainedNo ChangeN/A




SDCArchitecture(tick)

MaintainedMinor UpdateN/A




SDCRelease Notes(tick)

MaintainedMinor UpdateN/A




AAIOffered APIs(tick)https://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 API(tick)https://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 Notes(tick)https://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 GUI?https://git.onap.org/aai/esr-gui/tree/docshttps://docs.onap.org/projects/onap-aai-esr-gui/en/latest/index.html#master-index?







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








AAISparky BE Server?https://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(tick)https://git.onap.org/integration/tree/docs/release-notes.rsthttps://docs.onap.org/projects/onap-integration/en/latest/release-notes.html#release-notesMaintainedMinor Update





IntegrationUser Guide including use case documentation(tick)

https://git.onap.org/integration/tree/docs

https://git.onap.org/integration/tree/docs/docs_usecases.rst

https://docs.onap.org/projects/onap-integration/en/latest/onap-integration-ci.html#integration-ci

https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases.html#docs-usecases

MaintainedMinor Update





IntegrationTest Developer Guide(tick)

NewInitial Publication





MultiCloudArchitecture(tick)https://git.onap.org/multicloud/framework/tree/docshttps://docs.onap.org/projects/onap-multicloud-framework/en/latest/MultiCloud-Architecture.htmlMaintainedNo ChangeN/A




MultiCloudREST API(tick)https://git.onap.org/multicloud/framework/tree/docshttps://docs.onap.org/projects/onap-multicloud-framework/en/latest/index.html#master-indexMaintainedNo ChangeN/A




MultiCloudUser Guide(tick)https://git.onap.org/multicloud/framework/tree/docshttps://docs.onap.org/projects/onap-multicloud-framework/en/latest/index.html#master-indexMaintainedNo ChangeN/A




MultilCoudRelease Notes(tick)https://git.onap.org/multicloud/framework/tree/docs/Release%20Notes.rsthttps://docs.onap.org/projects/onap-multicloud-framework/en/latest/Release%20Notes.html








ONAP CLIRelease notes(tick)https://git.onap.org/cli/tree/docshttps://docs.onap.org/projects/onap-cli/en/latest/index.html#master-indexMaintainedMinot updatesN/A




VNFSDK

release notes

API

(tick)

MaintainedMinot updatesN/A




DCAEArchitecture(tick)https://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/architecture.htmlMaintainedMinor Update





DCAERelease Notes(tick)https://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/release-notes.htmlMaintainedMinor Update





DCAEOffered API's(tick)https://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/offeredapis.htmlMaintainedMinor Update





DCAEConsumed API's(tick)https://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/consumedapis.htmlMaintainedMinor Update





DCAE

MOD User guide

(tick)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 Components(tick)https://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(tick)

MaintainedMinor UpdateN/A




VNFRQTSProvider Docs(tick)

MaintainedMinor Update





DMAAPArchitecture and Usage(tick)https://git.onap.org/dmaap/buscontroller/tree/docs/architecturehttps://docs.onap.org/projects/onap-dmaap-buscontroller/en/latest/architecture/architecture.htmlMaintainedNo ChangeN/A




DMAAPRelease Notes(tick)https://git.onap.org/dmaap/buscontroller/tree/docs/release-noteshttps://docs.onap.org/projects/onap-dmaap-buscontroller/en/latest/release-notes/release-notes.htmlMaintainedMinor ChangeN/A




DMAAPData Controller API(tick)https://git.onap.org/dmaap/dbcapi/tree/docshttps://docs.onap.org/projects/onap-dmaap-dbcapi/en/latest/index.html#master-index








DMAAPData Router(tick)https://git.onap.org/dmaap/datarouter/tree/docshttps://docs.onap.org/projects/onap-dmaap-datarouter/en/latest/index.html#master-index








DMAAPMessage Router(tick)https://git.onap.org/dmaap/messagerouter/messageservice/tree/docshttps://docs.onap.org/projects/onap-dmaap-messagerouter-messageservice/en/latest/index.html#master-index








PORTALRelease Notes(tick)

MaintainedMajor UpdateN/A




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




CCSDKRelease Notes(tick)https://git.onap.org/ccsdk/distribution/tree/docshttps://docs.onap.org/projects/onap-ccsdk-distribution/en/latest/release-notes.htmlMaintainedMinor updateN/A




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








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








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








CCSDKORAN?https://git.onap.org/ccsdk/oran/tree/docs









SDNCOffered APIs(tick)

MaintainedMinor Update





SDNCRelease Notes(tick)

MaintainedMinor UpdateN/A




DOCRelease Notes(tick)https://git.onap.org/doc/tree/docs/release-notes.rsthttps://docs.onap.org/en/latest/release/index.htmlMaintainedMinor UpdateN/A




DOCLanding page(tick)https://git.onap.org/doc/tree/docshttps://docs.onap.org/en/latest/index.htmlMaintainedMinor UpdateN/A




DOCComposite release note(tick)https://git.onap.org/doc/tree/docs/releasehttps://docs.onap.org/en/latest/release/releaserepos.html#doc-releasereposMaintainedMinor UpdateN/A




DOCONAP User Guides(tick)https://git.onap.org/doc/tree/docs/guides/onap-userhttps://docs.onap.org/en/latest/guides/onap-user/index.htmlMaintainedMinor UpdateN/A




DOCONAP Operation Guides(tick)https://git.onap.org/doc/tree/docs/guides/onap-operatorhttps://docs.onap.org/en/latest/guides/onap-operator/index.htmlMaintainedMinor UpdateN/A




DOCRST Templates(tick)https://git.onap.org/doc/tree/docs/templates








DOCDOC Developer Guide(tick)https://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 Reference(tick)https://git.onap.org/doc/tree/docs/guides/onap-developer/apirefhttps://docs.onap.org/en/latest/guides/onap-developer/apiref/index.html







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







DOCONAP Component Document Index(tick)https://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 Architecture(tick)https://git.onap.org/doc/tree/docs/guides/onap-developer/architecturehttps://docs.onap.org/en/latest/guides/onap-developer/architecture/index.html







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







OOMSetup Guide(tick)

MaintainedMinor UpdateN/A




OOMRelease Notes(tick)

MaintainedMinor UpdateN/A




EXTAPIArchitecture(tick)https://git.onap.org/externalapi/nbi/tree/docs/architecture/architecture.rsthttps://docs.onap.org/projects/onap-externalapi-nbi/en/latest/architecture/architecture.htmlMaintainedNo ChangeN/A




EXTAPIOffered APIs(tick)https://git.onap.org/externalapi/nbi/tree/docs/offeredapishttps://docs.onap.org/projects/onap-externalapi-nbi/en/latest/offeredapis/offeredapis.htmlMaintainedMinor UpdateN/A




EXTAPIConsumed APIs(tick)https://git.onap.org/externalapi/nbi/tree/docs/consumedapishttps://docs.onap.org/projects/onap-externalapi-nbi/en/latest/consumedapis/consumedapis.htmlMaintainedMinor UpdateN/A




EXTAPIInstallation(tick)https://git.onap.org/externalapi/nbi/tree/docs/architecture/architecture.rsthttps://docs.onap.org/projects/onap-externalapi-nbi/en/latest/installation/installation.htmlMaintainedNo ChangeN/A




EXTAPIDeveloper Guide(tick)https://git.onap.org/externalapi/nbi/tree/docs/architecture/NBI_Developer_Guide.rsthttps://docs.onap.org/projects/onap-externalapi-nbi/en/latest/architecture/NBI_Developer_Guide.htmlMaintainedNo ChangeN/A




EXTAPIRelease Notes(tick)https://git.onap.org/externalapi/nbi/tree/docs/releasenoteshttps://docs.onap.org/projects/onap-externalapi-nbi/en/latest/releasenotes/releasenotes.html








MSBArchitecture(tick)https://git.onap.org/msb/apigateway/tree/docs/platform/architecture.rsthttps://docs.onap.org/projects/onap-msb-apigateway/en/latest/platform/architecture.htmlMaintainedNo ChangeN/A




MSBOffered APIs(tick)https://git.onap.org/msb/apigateway/tree/docs/platform/offeredapis.rsthttps://docs.onap.org/projects/onap-msb-apigateway/en/latest/platform/offeredapis.htmlMaintainedNo ChangeN/A




MSBConsumed APIs(tick)https://git.onap.org/msb/apigateway/tree/docs/platform/consumedapis.rsthttps://docs.onap.org/projects/onap-msb-apigateway/en/latest/platform/consumedapis.htmlMaintainedNo ChangeN/A




MSBInstallation(tick)https://git.onap.org/msb/apigateway/tree/docs/platform/installation.rsthttps://docs.onap.org/projects/onap-msb-apigateway/en/latest/platform/installation.htmlMaintained No ChangeN/A




MSBRelease Notes(tick)https://git.onap.org/msb/apigateway/tree/docs/release-notes.rsthttps://docs.onap.org/projects/onap-msb-apigateway/en/latest/release-notes.html








MSBSwagger API?https://git.onap.org/msb/swagger-sdk/tree/docshttps://docs.onap.org/projects/onap-msb-swagger-sdk/en/latest/index.html#master-index








APPCAPPC Deployment(tick)https://git.onap.org/appc/deployment/tree/docshttps://docs.onap.org/projects/onap-appc-deployment/en/latest/index.html#master-index








APPCAPPC Documentation(tick)https://git.onap.org/appc/tree/docshttps://docs.onap.org/projects/onap-appc/en/latest/index.html#master-index








AAFApplication Authorization Framework(tick)https://git.onap.org/aaf/authz/tree/docshttps://docs.onap.org/projects/onap-aaf-authz/en/latest/index.html#master-index








AAFSecret Management Service(tick)https://git.onap.org/aaf/sms/tree/docshttps://docs.onap.org/projects/onap-aaf-sms/en/latest/index.html#master-index








LoggingLogging Guide?https://git.onap.org/logging-analytics/tree/docshttps://docs.onap.org/projects/onap-logging-analytics/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