Versions Compared

Key

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

Contents

Table of Contents
minLevel1
maxLevel7
excludeContents

Agenda

Anchor
todos
todos
Work Items

...

  •  oI: Plan Follow-up call Wed 11am weekly
  •  STPH: Document list of steps aligned to phases on Release 2022-10 into Release Checklist for Maintainer [Draft] - Release 2022-04 and restructure Checklist the checklist accordingly
    •  Necessary steps for “Preparation and Deployment” are documented and up-to-date (deliverables, pull-requests, version control & tagging, package manager, testing, staging, configuration, update release documentation, update architecture documentation, update sandbox landscape, etc)
    •  STPH: Lead discussion of version management → Developer Committee
  •  STPH: Archive Wiki-Release notes and update columns in Sources Table
  •  Finalize Checklist
  •  Apply Checklist on Release 2022-04
  •  Fix Findings of Release 2022-04

...

Preparation and Deployment

Releases Page Releases

  •  Analyze linked issues as a normal user (private projects hidden)
  •  All links are working and are helpful
  •  Dates and status of all releases are correct

Release Page

e.g. Release 2022-04

  •  All links are working and are helpful
  •  Release is marked as “GA” and dates are correct
  •  All relevant tickets are assigned
  •  All assigned tickets are marked “Done” or pushed to the next release
  •  Epics align with the “Highlights” of the release

Release Sources Page

e.g. Sources Release 2022-04

  •  All components are consistently versioned according to Version management
  •  All links are working and helpful
  •  All components link to the correct repository and version
  •  All components have correct “Release Notes”
  •  All components link to reasonably similiar named repositories / package manager

Release Notes

Release notes and Sub Pages

  •  Release notes Shows the latest release notes of all sub pages
  •  All sub pages of Release notes contain the same release notes of the latest version as the repository (at the time of the release)

User Documentation

Installation Guide / Configuration / Other

Sandbox Landscape Sandbox Landscape

Post-Release

  •  Release Page (e.g. Release 2022-04) for the following release is set up and appears correctly on Releases
  •  Relevant Epics for the new release were created in Jira and added to the Release Page

...

Questions

  •  How do we keep the version (link) of every component in Sources Release 2022-04 in sync with every component’s “Release notes” page (e.g. openIMIS Database release notes) as well as with what is actually in the repository?
  •  How can we define “Epics” that represent better the added value (see mismatch between Release 2022-04 Epics and Highlights)?

Anchor
future
future
Future Improvements

  •  Dedicated page for each module under openIMIS Modules (with Page Properties, descriptions/basic explaination, version history - Based on release notes pages?)
  •  Clarify wording module / component / repository - Define and document for example “Claim AI” from different perspectives - “Claim AI” Module contains the Components “Claim AI BE” and “Claim AI FE” “?
  •  openIMIS Feature: One-Click-Installation with selection of modules instead of installing components one by one / Define Standard-Installation
  •  Rethink grouping of Components on Release 2022-04 according to Modules ->
  •  Include repository info instead of redundancy (and info gaps) between Release notes and repositories on GitHub (PlugIn?)
  •  Clarify usage of Pypi.org and npmjs.org with GitHub (calcrule links to GitHub, others to PyPi)
  •  Update Installation Guides (Docker and Non-Docker)
  •  Dependency Graph for modules / consistent dependency information in Sources Release 2022-04
  •  Reevaluate “Testing openIMIS” on Sources Release 2022-04
  •  Consider “Legacy” modules as “Deprecated” on Sources Release 2022-04
  •  Sort components by name on Sources Release 2022-04?
  •  Release 2022-04 Reevaluate redundant information in “Highlights” and “Release Notes”
  •  Combine Releases / Release 2022-04 , Release notes and Sources/Sources Release 2022-04 to reduce structural redunancy and confusion
  •  Clarify wording redundancy “openIMIS …” for components, modules, wiki pages, etc.

...