Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Release Notes for 3.2.0 in ReadTheDocs

Description

As an implementer, I want to view Release Notes in the OpenLMIS Documentation website (powered by ReadTheDocs) so that release notes are versioned and organized with our other technical documentation. (Not in the OpenLMIS wiki, where previous Release Notes have been published.)

Starting with OpenLMIS 3.2.0, we are publishing this in ReadTheDocs using RST formatting.

Acceptance Criteria:

  • Write 3.2.0 release notes.

    • Share a draft with and at least 72 hours before release day on August 30, 2017.

    • Highlight the performance improvements, the pull requests, specifically list the new features, data migrations, etc. Include screenshots – if ReadTheDocs allows it – or link to showcase videos for the main new features.

    • Capture text from Chongsun and Josh about the 2 related linked tickets (OLMIS-2924, ). Also please ping Team Malawi () to be aware of these changes.

  • Include all the same kinds of content (key changes for each component) as we did in past release notes in the wiki.

  • Next to older release notes in the Wiki, put a message with a link saying that future release notes are in ReadTheDocs (docs.openlmis.org).

  • In the new ReadTheDocs release notes, put a message with a link saying that past release notes are in the wiki.

QAlity Plus - Test Management

Checklists

Activity

Mary Jo Kochendorfer 
August 29, 2017 at 3:15 PM

, I haven't had much time to review but I've been updating tickets with the 3.2 fix version. The structure looks good to me and I'll be able to help on this later today.

Brandon Bowersox-Johnson 
August 25, 2017 at 11:59 PM
(edited)

and I have a draft outline in place now at http://docs.openlmis.org/en/latest/releases/openlmis-ref-distro-v3.1.2.html

If you click "Edit in GitHub" you can use that web-based editor to put in content. Of course any changes also require triggering Jenkins job openlmis-documentation to build and wait a few minutes for docs.openlmis.org to be updated.

Instead of the GitHub online editor, you may want to use Sublime Text 2 (http://www.sublimetext.com/2) and it has a plug-in called Omni Markup Previewer (https://github.com/timonwong/OmniMarkupPreviewer). I can help you install when I'm back Tuesday, and Josh also knows how to use it. It's not great, but at least it allows you to live-preview your changes in a browser window.

Done
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Story Points

Sprint

Fix versions

Priority

Time Assistant

Created August 15, 2017 at 8:06 PM
Updated September 1, 2017 at 11:27 PM
Resolved September 1, 2017 at 11:27 PM