Public Facing
General
structure the documentation landing page: Documentation (developer, implementer, user)
Sandbox Landscape : near time status updates
Release Notes - Releases
SEO for the wiki
Wiki-Structure
openIMIS Product
Demo server - Should that be here?
openIMIS User
openIMIS Development
openIMIS Community
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
Update 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
Update 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 Knowledge Base (see Modular Migration: Open Issues )
Cleanup Quality assurance and Document Testing Scenarios ↔︎ Dev Committee #223
Update and Integrate openIMIS Integrations into Documentation
Update and Integrate Sandbox Landscape into openIMIS Product
Update and Integrate Translation Management platform into Documentation
Cleanup and Integrate JIRA reports into openIMIS Product
Cleanup and Integrate Issue tracking into openIMIS Product
Update and Integrate Use cases served by openIMIS - overview into Documentation
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
Cleanup and Integrate code and publishing management into Documentation
Update Version management
Update Contribution guidelines
Update Extended Github workflow
Integrate Updating all python modules CI github workflow into Knowledge Base
Integrate “
Automated CI testing
" of code and publishing management into Knowledge Base
Update YouTube content for Release 2022-04 / current development ↔︎ Dev Committee #176
Conceptual notes
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
Cleanup and Integrate Modular Transformation (e.g. Target (modular) Architecture ) into Documentation
Cleanup and Integrate Target Technology Stack into Documentation
Cleanup and Integrate (new) openIMIS installations into Documentation
Cleanup and Integrate JLN Process - OpenIMIS Mapping into Documentation
Cleanup and Integrate openIMIS Database Design into Documentation
Update each module in openIMIS Modules ↔︎ Dev Committee #260
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 up Release notes into Releases
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 Knowledge Base as “How-to”
Cleanup and Integrate further mature/not-in-development content into Documentation
Standardize naming in Knowledge Base “How to” etc. …
Standardize naming in openIMIS Product substructure explicitely “openIMIS” everywhere or nowhere
Internal Documentation (under Maintenance Contract Project: 2020.T1 Maintenance )
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