Content
Agenda
Review and delete finished Work Items
Discuss Future Improvements and agree on next Work Items
Work Items
- User Manual:
- Update logo to current CI
- Rename “Install Documentation” to “Installation Guide”
- 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: Document list of steps aligned to phases on Release 2022-10 into Checklist for Release 2022-10 and restructure the checklist accordingly
- STPH: Lead discussion of version management → Developer Committee
- Use release checklist during the release to update about the status in the Dev Call
- 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
- 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)
- Docker / Non-Docker
- Docker for Desktop?
- 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 Improvements
- 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” 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 redundancy and confusion
- Clarify wording redundancy “openIMIS …” for components, modules, wiki pages, etc.