...
Content
| Table of Contents | |||||
|---|---|---|---|---|---|
|
...
|
Agenda
...
- KickOff / Brief overview this Page
- Find a time slot for weekly documentation-call
- Review of the Checklist
- Review of the Findings of Release 2022-04
- Define and agree on Todos
Review and delete finished Work Items
Discuss Future Improvements and agree on next Work Items
| Anchor | ||||
|---|---|---|---|---|
|
...
Work Items
...
...
- Release 2022-
...
- 10 / Completely mark off all todos on Checklist for Release 2022-10
...
Preparation and Deployment
- 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)
- All affected repositories (GitHub, Pypi.org, http://npmjs.com , etc.) are tagged and versioned according to Version management (Versioning to be discussed in detail in a future session)
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
- 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
- User Documentation is up-to-date http://docs.openimis.org/en/latest/ / http://docs.openimis.org/fr/latest/
Installation Guide / Configuration / Other
- Installation guide / Installation and Country Localisation supports installation of the latest release
- Developer Starter Kit reflects latest release
- “Technical Requirements” / Connectivity & theoretical infrastructure required reflects lastest release
- Tutorials on YouTube are up-to-date / not misleading
Sandbox Landscape Sandbox Landscape
- Demo: openIMIS Instance and Wiki page are up to date
- Release: openIMIS Instance and Wiki page are up to date
- Sandbox Landscape Other instances are up to date / compatible with Demo: openIMIS / Release: openIMIS
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
...
- Release 2022-04 Status is not “GA”
- Releases Status of Release 2022-04 is not “GA”
- Release 2022-04 List of assigned tickets seems to be incomplete (Huge changelog for Legacy Web App, but empty list of tickets!?)
- Release 2022-04 Some assigned tickets are not “Done”
- Release 2022-04 Link to “Release Notes” is broken
- Sources Release 2022-04 Chapter General/Intro: Most links are broken or not helpful
- Sources Release 2022-04 Chapter “Database”: Link “Installation guide” is broken
- Sources Release 2022-04 Chapter “Docker scripts”: Links for “Installation guide” and “Dependencies” are broken
- Sources Release 2022-04 Some version numbers have 4 digits, others 3
- Sources Release 2022-04 Some version numbers have “rc..”, “April” and so on in their names
- Sources Release 2022-04 “Installation guide” links in “openIMIS modular version - Docker scripts” are broken
- Sources Release 2022-04 Double “BE Claim AI module”
- Sources Release 2022-04 “FE French Translations module” - Missing “Release Notes”
- Sources Release 2022-04 “FE Claim Batch module” - Missing “Release Notes”
- Sources Release 2022-04 “FE French Translations module” - Mismatch between name of module and name of repository / Mismatch between “Version” and “Repository” (wrong repo “openimis-fe-tools.js” ?)
- Sources Release 2022-04 Most (all?) dependency links are broken
- Sources Release 2022-04 Most (all?) links to installation guides are broken
- Sources Release 2022-04 Link to ”Backend installation guide” is broken
- Sources Release 2022-04 Link to “Frontend installation guide” is missing
- Sources Release 2022-04 Some components don’t link to the “latest” on GitHub (e.g. Claims mobile application)
- Release notes Warns about an old release → Release 2021-04
- Release notes Is inconsistent and messy
- Sources Release 2022-04 Does not link to the latest version according to openIMIS Frontend assembly release notes and GitHub
- Sources Release 2022-04 “BE Calcrule Contribution Legacy module” does not link to a version
- openIMIS BE Calcrule Contribution Legacy module release notes does not link to a version
- Sources Release 2022-04 “BE Calcrule Capitation Payment module” does not link to a version
- openIMIS BE Calcrule Capitation Payment module release notes does not link to a version
- Sources Release 2022-04 “BE Tools module” does not link to a version
- openIMIS BE Calcrule Capitation Payment module release notes does not link to a version
- Sources Release 2022-04 “Frontend assembly” points to an old version
- Sources Release 2022-04 “FE French Translations module” points to an old version but names a new version
- openIMIS FE Home module release notes Is not up2date
- Sources Release 2022-04 “FE Claim Batch module” points to an old version
- openIMIS Policies Mobile Application release notes is not up2date
- Sources Release 2022-04 “Policies mobile application” points to an old version
- Sources Release 2022-04 “Claims mobile application” points to an old version
- openIMIS Claims Mobile Application release notes is not up2date
- Sources Release 2022-04 All BE modules point to http://pypi.org except “Backend assembly”, “BE Calcrule Contribution Legacy module”, “BE Calcrule Capitation Payment module“, “BE Tools module”
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)?
- Collecting (writing) documentation
- Insuree batch
- Insuree self registration (from Nepal)
- Add epics and include features/fixes on release page
- Quick check sandbox
- Documentation
- Include logo on the wikipedia page (what copyright shall we use?)
- Installation Guide (IG):
- Move all relevant content under “Installation Guide” (Remove redundancy)
- Lower the complexity (number of pages)
- Separate installation guide of legacy content
- Separate installation guide of localization / customization
- Simplify navigation
- https://www.youtube.com/watch?v=e0nhczKMHhw needs a description and a link to the (details of the) IG
- Embedd https://www.youtube.com/watch?v=e0nhczKMHhw into the new IG
- Harmonize instructions in the IG, https://www.youtube.com/watch?v=e0nhczKMHhw and on GitHub
- STPH: Do Post-Release of Release 2022-10
- STPH: Installation Guide (Video) / One-Click-Install / Step-by-Step-Instructions
- Merge existing YT playlists openIMIS Installation and Country Localization Session 1 +2
- https://www.youtube.com/playlist?list=PLWKJKsJBiT3I0kPxDEjiOpT6_sX01pl3Q is called “Legacy openIMIS Web Application installation tutorials” on Installation Guide
- https://www.youtube.com/playlist?list=PLWKJKsJBiT3LlFCac1D7yQqj-AbSGD4ic is called “Legacy openIMIS Web Application customisation tutorials” on Installation Guide
- https://www.youtube.com/playlist?list=PLWKJKsJBiT3I0kPxDEjiOpT6_sX01pl3Q is used on Starter Kit Toumai and Programme integration Consultant IT – Point Focal openIMIS
- https://www.youtube.com/playlist?list=PLWKJKsJBiT3LlFCac1D7yQqj-AbSGD4ic is used on Starter Kit Toumai and Programme integration Consultant IT – Point Focal openIMIS and Country and Localization Training, Session 2
- Playlists can’t simply be merged but will need to be reorganized (separate legacy content from the rest)
- French version of Docker Installation Guide
- Update Installation Guide to focus on “Modular” (put “Legacy” at the end)
- Rewire/reembedd youtube content for modular installation
- Add further services to https://stats.uptimerobot.com/k7kyZik8w8
- UpdateTimeRobot Notifications on discord → Demo-Server
- Others (Dev, Release, etc.) needed?
Talking Points Installation Guide
- Docker Installation Video is not embedded in the IG
- Define Requirements of the IG
- Is Simple and complete - Can be followed without knowing the tools
- Is fully documented on one platform (Wiki) and free of redundancies
- Works (= is tested) in all supported scenarios (e.g. platforms, OS version, databases)
- Installation with Docker
- Version update guide
- Version upgrade guide Legacy → Modular / MS SQL → PostgreSQL (DeepDive)
- Focus on standard installation (Linux (Debian-based) 64-bit, (specific version with LTS), PostgreSQL)
- Community Installation Blog with individual installation experiences (Maybe as part of 4. Installation test in Test cases overview)
- Non-Docker
- Windows etc.
- Multi-OS (Windows, Linux, 32/64 Bit, including a reasonable range of versions) capable
- Multi-DB (MS SQL, PostgreSQL) capable
- Multilanguage capable
- Minimum Requirements are documented
- Legacy Installation Guide is exluded and/or archived
- Future outlook of deployment / installations
| Anchor | ||||
|---|---|---|---|---|
|
- Dedicated page for each module under openIMIS Modules (with Page Properties, descriptions/basic
...
- explanation, 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 ->
...
- 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”
...
...
- 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
...
- redundancy and confusion
- Clarify wording redundancy “openIMIS …” for components, modules, wiki pages, etc.