Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 38 Next »

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

CLAMPArchitectureMaintainedNo ChangeN/A

CLAMP Architecture

POLICYArchitectureMaintainedMinor UpdateN/A
(tick)

Policy Framework Architecture



POLICYOffered APIsMaintainedMinor UpdateN/A
(tick)

Policy Offered APIs



POLICYDevelopment GuideMaintainedMinor UpdateN/A
(tick)

Policy Platform Development



HOLMESArchitectureMaintainedNo ChangeN/A




HOLMESOffered APIsMaintainedNo ChangeN/A




HOLMESConsumed APIsMaintainedMinor UpdateN/A




HOLMESInstallationMaintainedMinor UpdateN/A




ModelingArchitectureYuanhong DengMaintainedMinor UpdateN/A




ModelingOffered APIsYuanhong DengMaintainedMinor UpdateN/A




OOFArchitectureMaintainedMinor UpdateN/A(tick)
OOF Architecture

OOFOffered APIsMaintainedMinor UpdateN/A(tick)
OOF Offered APIs

OOFRelease NotesMaintainedMinor UpdateN/A(tick)
OOF Release Notes

VFCOffered APIsYuanhong DengMaintainedMinor UpdateN/A




SOArchitectureSeshu Kumar MudigantiMaintainedMinor UpdateN/A




SOOffered APIsMaintainedMinor UpdateN/A




SODevelopment GuideMaintainedMinor UpdateN/A




VIDRelease NotesittayMaintainedMinor UpdateN/A




VIDSwagger API

ittay , automatically generated

MaintainedNo ChangeN/A




VIDUser GuideittayMaintainedNo ChangeN/A




Usecase UIRelease NotesMaintainedMinor UpdateN/A




Usecase UIUser GuideMaintainedMinor UpdateN/A




Usecase UIInstallation GuideMaintainedNo ChangeN/A




SDCArchitectureChrisCMaintainedMinor UpdateN/A
(tick) (Oct DDF)SDC Documentation

SDCRelease NotesMaintainedMinor UpdateN/A
(tick) (Oct DDF)SDC Release Note

AAIOffered APIsMaintainedMinor Update





AAIAAI REST APIWilliam ReehilMaintainedMinor Update





AAIRelease NotesWilliam ReehilMaintainedMinor Update





IntegrationRelease NotesMaintainedMinor Update





IntegrationUser Guide including use case documentationMaintainedMinor Update





IntegrationTest Developer GuideNewInitial Publication





MultiCloudArchitectureMaintainedNo ChangeN/A




MultiCloudRESP APIMaintainedNo ChangeN/A




MultiCloudUser GuildMaintainedNo ChangeN/A




ONAP CLIRelease notesMaintainedMinot updatesN/A




VNFSDK

release notes

API

MaintainedMinot updatesN/A




DCAEArchitectureMaintainedMinor Update





DCAERelease NotesVijay KumarMaintainedMinor Update





DCAEOffered API'sVijay KumarMaintainedMinor Update





DCAEConsumed API'sMaintainedMinor Update





DCAE

MOD User guide

MaintainedMinor Update





DCAEDCAE Service ComponentsMaintainedMinor Update on existing components + new Guilin components





VVPVVP Documentationsteven starkMaintainedMinor UpdateN/A




VNFRQTSProvider DocsTrevor LovettMaintainedMinor Update





DMAAPArchitecture and UsageMandar SawantMaintainedNo ChangeN/A




DMAAPRelease NotesMandar SawantMaintainedMinor ChangeN/A




PORTALRelease NotesMaintainedMajor UpdateN/A




CCSDKCDS User GuideMaintainedMinor updateN/A




CCSDKRelease NotesDan TimoneyMaintainedMinor updateN/A




SDNCOffered APIsDan TimoneyMaintainedMinor Update





SDNCRelease NotesDan TimoneyMaintainedMinor UpdateN/A




DOCRelease NotesSofia WallinMaintainedMinor UpdateN/A




DOCLanding pageSofia WallinMaintainedMinor UpdateN/A




DOCComposite release noteMaintainedMinor UpdateN/A




DOCONAP User GuidesSofia WallinMaintainedMinor UpdateN/A




DOCONAP Operation GuidesSofia WallinMaintainedMinor UpdateN/A




OOMSetup GuideMaintainedMinor UpdateN/A




OOMRelease NotesMaintainedMinor UpdateN/A




EXTAPIArchitectureAdrian OSullivanMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-externalapi-nbi/en/guilin/architecture/architecture.html

EXTAPIOffered APIsAdrian OSullivanMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-externalapi-nbi/en/guilin/offeredapis/offeredapis.html

EXTAPIConsumed APIsAdrian OSullivanMaintainedMinor UpdateN/A

https://docs.onap.org/projects/onap-externalapi-nbi/en/guilin/consumedapis/consumedapis.html

EXTAPIInstallationMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-externalapi-nbi/en/guilin/installation/installation.html

EXTAPIDeveloper GuideMaintainedNo ChangeN/A

https://docs.onap.org/projects/onap-externalapi-nbi/en/guilin/architecture/NBI_Developer_Guide.html

MSBArchitectureFormer user (Deleted)MaintainedNo ChangeN/A




MSBOffered APIsFormer user (Deleted)MaintainedNo ChangeN/A




MSBConsumed APIsFormer user (Deleted)MaintainedNo ChangeN/A





InstallationFormer user (Deleted)Maintained No ChangeN/A





























































































































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