Versions Compared

Key

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

...

Project Name

Repository (one per row)
(Please list any repo that contains documentation to be published with the release)
Does Repo Contain New Documentation
(yes / no)

Documentation Owner(s)
(name - use @ notation)

Preliminary Documentation

New docs or new projects ONLY 

(enter "N/A" if not applicable, or link to gerrit request if completed)

Link to Final Documentation in ReadTheDocs (stable/istanbul branch)

Reviewed by the doc project
(reviewed means release related content. Such as release notes and release name were applicable)

By best effort! 

M2



M4RC2Sign Off






































































Procedure

...

M2

  1. Find JIRA task attached to M1 M2 Epic for your project, if you haven't already done so.
  2. In the table above, fill in the first 4 columns:
    • project name
    • doc title,
    • Project name
    • Repositories that contain documentation to be published with the release (one per row)
    • Does the repository contain new documentation (yes/no)
    • Documentation owner(s) (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

...

M4

  1. Find JIRA task attached to M2 M4 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 RC2 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.

...