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

HOLMESArchitectureMaintainedMinor UpdateN/A




HOLMESConfigurationMaintainedMinor UpdateN/A




HOLMESConsumed APIsMaintainedMinor UpdateN/A




HOLMESHuman InterfacesMaintainedMinor UpdateN/A




HOLMESInstallationMaintainedMinor UpdateN/A




HOLMESLogging & Diagnostic InformationMaintainedMinor UpdateN/A




HOLMESRelease NotesMaintainedMinor UpdateN/A




Usecase UIRelease NotesMaintainedMinor UpdateN/A




Usecase UIUser GuideMaintainedMinor UpdateN/A




Usecase UIInstallation GuideMaintainedMinor UpdateN/A




VFCArchitectureYuanhong DengMaintainedMinor UpdateN/A




VFCDeliveryMaintainedMinor UpdateN/A




VFCRelease NotesMaintainedMinor UpdateN/A




ModelingArchitectureYuanhong DengMaintainedMinor UpdateN/A




ModelingConsumed APIsYuanhong DengMaintainedMinor UpdateN/A




ModelingRelease NotesYuanhong DengMaintainedMinor UpdateN/A




SORelease NotesSeshu Kumar MudigantiMaintainedMinor UpdateN/A




SOArchitectureSeshu Kumar MudigantiMaintainedMinor UpdateN/A




SOUser GuideMaintainedMinor UpdateN/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

...