Collection of tasks to improve openIMIS Documentation
Public Facing
General
wiki
structure the documentation landing page: Documentation (developer, implementer, user)
Sandbox Landscape : near time status updates
Release Notes - Releases
SEO for the wiki
Rework wiki “Space Shortcuts”
list of regular wiki maintenance tasks (e.g. update events, opportunities, projects, clean archive …)
Web-Page
introduce issue queue for web-maintenance
maintain Incoming links from openIMIS.org
Users
User documentation: http://docs.openimis.org/en/latest/ / http://docs.openimis.org/fr/latest/
which platform for user docs? readthedocs (current standard, but outdated)? gitbook? wiki?
Updated FAQ List
Outdated user documentation (Different Styles)
Implementers
Validate and Integrate Installation and Country Localisation into Documentation
Update Installation and Country Localisation to allow newbies to quickly setup the current version
Clean up naming: “modular” is default case and doesn’t need to be especially designated as such for the purpose of Documentation , “legacy” is special case, its content need to be updated/removed/archived to reflect the new reality - E.g. in Installation and Country Localisation - This also needs to be reflected in documentation within the (GitHub) repositories
Validate and Integrate Generic Implementation Starter Kit into Documentation
Update Resource requirements
Integrate further mature/non-development content into Documentation
Describe Configuration/Customization (per module) in Documentation ↔︎ Dev Committee #288
Update Demo server to latest version (currently 1.1.3) - OSD-179Getting issue details... STATUS
Document versioning - How to maintain a visible “main version number” and organize versions for modules while inter-module-compability can be understood
Create “How to migrate from Legacy to Modular” in https://openimis.atlassian.net/wiki/spaces/OP/pages/3286204427 (see Modular Migration: Open Issues )
ValidateQuality assurance and Document Testing Scenarios ↔︎ Dev Committee #223
Validate and Integrate openIMIS Integrations into Documentation
Validate and Integrate Sandbox Landscape into openIMIS Product
Validate and Integrate Translation Management platform into Documentation
Validate and Integrate JIRA reports into openIMIS Product
Validate and Integrate Issue tracking into openIMIS Product
Validate and Integrate Use cases served by openIMIS - overview into Documentation
Domain Knowledge
Include Domain Knowledge into Wiki Target Structure [Draft]
Consolidate existing Knowledge -> Make available in FR/EN/..
Provide a Needs-centered Access to openIMIS
Setup Prozess for Transform Product Owner / Incubator Knowledge to Documentation
Setup Framework to Improve Recording, Documentation and Publishing of Webinars
Priorization Toumai Community
Modular Approach and Modules
Interoperability (FHIR/DHIS2…)
AI Modules
Mobile Versions (Examples) / Payment Module (Examples)
Developers
Development guidelines
Update Developer Starter Kit for Release 2022-04
Update Installation guide for Release 2022-04
Create “Technical Requirements” page and fill with content e.g. Connectivity & theoretical infrastructure required
Validate and Integrate code and publishing management into Documentation
Validate Version management
Validate Contribution guidelines
Validate Extended Github workflow
Integrate Updating all python modules CI github workflow into Documentation
Integrate “
Automated CI testing
" of code and publishing management into Documentation
Validate and integrate UI/UX Style Guide into Documentation
Validate YouTube content for Release 2022-04 / current development ↔︎ Dev Committee #176
Github
Clarify distribution of documention between GitHub repo and Wiki and remove redundancies
Clarify distribution of release notes between GitHub repo and Wiki and remove redundancies
Mark/Remove/Hide deprecated GitHub repos
Architecture
Reorganize structure in openIMIS Modules and create overview according to The JLN Process Matrix / JLN Process - OpenIMIS Mapping / https://docs.google.com/presentation/d/1eUqlOkK6MyTPZsQG3A8mZDzoIvFxzUtxi5r6UCVYYjc/edit#slide=id.g1192d288ca2_0_65 (slide 12) ↔︎ Dev Committee #105
Create dependency graph for openIMIS modules / repos in Documentation
Validate and Integrate Modular Transformation (e.g. Target (modular) Architecture ) into Documentation
Validate and Integrate Target Technology Stack into Documentation
Validate and Integrate (new) openIMIS installations into Documentation
Validate and Integrate JLN Process - OpenIMIS Mapping into Documentation
Validate and Integrate openIMIS Database Design into Documentation
Update each module in openIMIS Modules ↔︎ Dev Committee #260
Validate and Integrate finished Projects from Project Portfolio into Documentation (Architecture)
Release
Document Release Management into Documentation
step by step deliverables / check-list (integrate pull-requests, update doku, update modules overview)
Update Sources for https://openimis.atlassian.net/l/c/9WjwwJwE and optimize accessibility
Merge / move / clean uphttps://openimis.atlassian.net/wiki/spaces/OP/pages/368345128intoReleases
Documentation Methodology
How to document architecture: Graphics: repository for architecture etc done with draw.io
Re-organize first level children of Documentation e.g. create and move content into our Technical Knowledge Base as “How-to”
Validate and Integrate further mature/not-in-development content into Documentation
Standardize naming in our Technical Knowledge Base “How to” etc. …
Standardize naming in openIMIS Product substructure explicitely “openIMIS” everywhere or nowhere
Internal Documentation
under Maintenance Contract
Sandbox Server access / root account
keypass keyrings:
admin (on internal teams channel)
developers (on Google drive?)
GIZ internal
server contract login (keypass keyring)
DNS is still on cloudflare → Hetzner
web-page - wiki links: Incoming links from openIMIS.org
Remove / document / avoid content redundancies between web and wiki
Make sure the transition from web to wiki is smooth (especially for first time users)
Analyze backlinks from Wiki to Web - e.g. Chad (and other implementations) refers to http://openimis.org/tanzania on the web
Publish relevant Events on Web
Remove Welcome to the openIMIS Initiative! and other redundant content after launch of new version of Web
Taskforces
Taskforce | Involved Parties | Meetings |
---|---|---|
Release checklist, Server Doc (T1) Improving technical documentation, ensuring sustainable operations | STPH, GIZ | Weekly Wed. 11-12pm |
Server Administration & Accounts Consolidate server hosting credentials, migration of DNS host and access sharing strategies | GIZ, GIZ NP | Ongoing |
Optimizing accessibility to knowledge of the wiki for different target groups | GIZ | In Preparation |
Modular Architecture Document modular architecture, | GIZ, Blsq | In Preparation |