Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

CLAMPArchitectureMaintainedMinor UpdateN/A




POLICYArchitectureMaintainedMinor UpdateN/A




POLICYOffered APIsMaintainedMinor UpdateN/A




POLICYDevelopment GuideMaintainedMinor UpdateN/A




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




OOFOffered APIsMaintainedMinor UpdateN/A




OOFRelease NotesMaintainedMinor UpdateN/A




VFCOffered APIsYuanhong DengMaintainedMinor UpdateN/A




SOArchitectureSeshu Kumar MudigantiMaintainedMinor UpdateN/A




SOOffered APIsMaintainedMinor UpdateN/A




SODevelopment GuideMaintainedMinor UpdateN/A




VIDRelease NotesIttay SternMaintainedMinor UpdateN/A




VIDSwagger API

Ittay Stern , automatically generated

MaintainedNo ChangeN/A




VIDUser GuideIttay SternMaintainedNo ChangeN/A




Usecase UIRelease NotesMaintainedMinor UpdateN/A




Usecase UIUser GuideMaintainedMinor UpdateN/A




Usecase UIInstallation GuideMaintainedNo ChangeN/A




SDCArchitectureChristophe ClossetMaintainedMinor UpdateN/A




SDCRelease NotesMaintainedMinor UpdateN/A




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 Venkatesh KumarMaintainedMinor Update





DCAEOffered API'sVijay Venkatesh 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




EXTAPIOffered APIsAdrian OSullivanMaintainedMinor UpdateN/A




EXTAPIConsumed APIsAdrian OSullivanMaintainedMinor UpdateN/A




EXTAPIInstallationMaintainedNo ChangeN/A




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

...