Describes the steps required to QA and baseline the documentation for a release and prepare the documentation for the next development cycle.

 


Documentation Structure

Unreleased documentation is always maintained in the NASDOC Confluence Space. When a release is created, this space is copied to create a new space containing the version number - eg. NASDOC44 for version 4.4 of NAS. The documentation home page contains links to the childspace of the current release as well as a link to the unreleased documentation.

Quality assurance

  1. Update all screenshots to reflect the new GUI. The previous attachments should be deleted before the new attachment is uploaded to avoid cluttering the disk with version controlled old attachments.
  2. Review all documents.

Baseline

  1. Create the new Space (from the "Spaces" drop-down at the very top of the page).
  2. Navigate to the bleeding-edge documentation page (https://sbforge.org/display/NASDOC)
  3. Find the "Copy" link under the "..." link at the right of the page menu
  4. Click on "Copy" and fill in the newly-created space name
  5. Click to include child pages and click "Copy".
  6. Under "Space tools → Overview → Edit space details" set the documentation root to be the home page of the new space (also delete the old blank home page).
  7. In the new documentation root, go to "Space tools → Permissions" at the bottom left and update so the versioned space can be view Anonymously and commented on by all confluence-users.
  8. Update the Documentation page to make the children display point to the new release page.
  9. Add the label "nasdoc" to the new documentation root page
  10. Add this header to the previous released documentation through the Space tools → Look and Feel

    {info:icon=false}*Note that this documentation is for the old X.XX release.*
    For the newest documentation, please see the [current release documentation|NASDOCXXX:NetarchiveSuite documentation home].{info}


  11. Update the page _Major Release Number to point to the next expected release.
  12. Update the upcoming versions referred to by the bleeding edge documentation at https://sbforge.org/display/NASDOC
  13. After all this is done, the following should be checked:
    1. The documentation page (Documentation) has links to the documentation for the just-released version
    2. The documentation for the just-released version has no header
    3. The documentation for the previously-released version now has a header with a link to the just-released version
    4. The bleeding-edge documentation at NetarchiveSuite documentation has a header with a link to the documentation page and refers to an upcoming release

Prepare for next development cycle

Update any specific version info in the documentation to reflect the incremented version.