Wiki

• Restructure the documentation landing page: Documentation (developer, implementer, user)

• Provide near time status updates for Sandbox Landscape : Status monitor page for demo instance has been added, outstanding for others

• Reorganize Release Notes - Releases

• SEO for the Wiki and the Website - Communication

• Rework wiki “Spaces”

• List of regular wiki maintenance tasks (e.g. update events, opportunities, projects, clean archive …) → Wiki Maintenance

• Restructure Wiki (Wiki Target Structure [Draft] ) to optimize accessibility to knowledge for different target groups

  • Ensure usability for low resolution devices / old displays (e.g. including links to child pages on every page)

  • Ensure usability for old/slow devices e.g. by reducing the number of unnecessary page loads

• Ensure, that every page is converted to the new editor

• Provide translations (e.g. in French) of the most important content → communications

  • Harmonize multi-language selection/navigation → communication

• Use custom domain name for the Wiki (wiki.openimis.org)

  • Is currently not supported by the cloud-hosted Confluence Wiki → https://jira.atlassian.com/browse/CLOUD-6999

• Report Copy & Paste (Links) Bug

  • https://jira.atlassian.com/browse/CONFCLOUD-74361

Web-Page

• Introduce issue queue for web-maintenance → https://openimis.atlassian.net/jira/software/c/projects/OOW/boards/23

• Maintain https://openimis.atlassian.net/wiki/spaces/SB/pages/1025015809

• cross link language version in wiki-version of the web-page

Improve user documentation http://docs.openimis.org/en/latest/ / http://docs.openimis.org/fr/latest/

• Update user documentation to current cooperate design (use new logo)

• Links towards the Wiki need to be checked (e.g. “openIMIS Install documentation”)

• Ensure coherency of the linkage between the user documentation and other platforms (like the Wiki or the webpage)

Update FAQ List

• Remove usage of featured FAQ lists outside of the website sandbox

• Move to Sandbox

Validate and Integrate Installation Guide into Documentation

Update Installation Guide to allow people that are interested to quickly setup the current version in the supported environment (Linux & PostgreSQL)

• Variations as “Implementers Experience reports” as link out from the standard installation instruction e.g. “see other

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 Guide - This also needs to be reflected in documentation within the (GitHub) repositories

Validate and Integrate Health Insurance Solution - 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

Create “How to migrate from Legacy to Modular” (see Modular Migration: Open Issues)

Create “How to update from version / release x to version / release y” tutorial

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 openIMIS Solutions into Documentation

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

• Merge YT-Playlists https://www.youtube.com/playlist?list=PLWKJKsJBiT3I0kPxDEjiOpT6_sX01pl3Q and https://www.youtube.com/playlist?list=PLWKJKsJBiT3LlFCac1D7yQqj-AbSGD4ic

Validate and update Functional specification / Technical documentation

Integrate code documentation in Wiki (see https://openimis.atlassian.net/wiki/spaces/OP/pages/3370024961 )

Setup a “Source Code Opportunities” page where software solutions of projects like https://openimis.atlassian.net/wiki/spaces/OP/pages/3241574401, the solution of Bluesquare in Nepal or other prototypes / proof of concepts can be put, maintained and referred to, to be taken up and being further developed

Clarify distribution of documentation 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

Provide license information in every repository

Rework/create documentation of modular architecture https://openimis.atlassian.net/wiki/spaces/OP/pages/3376152582

Reorganize structure in https://openimis.atlassian.net/wiki/spaces/OP/pages/589561955 and create overview according to https://openimis.atlassian.net/wiki/spaces/OP/pages/807698543 / https://openimis.atlassian.net/wiki/spaces/OP/pages/945422345 / 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 https://openimis.atlassian.net/wiki/spaces/OP/pages/494338053 (e.g. https://openimis.atlassian.net/wiki/spaces/OP/pages/586383361 ) into Documentation

Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/606208025 into Documentation

Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/900595717 into Documentation

Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/945422345 into Documentation

Validate and Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/1445953560 into Documentation

Update each module in https://openimis.atlassian.net/wiki/spaces/OP/pages/589561955

• Create a link to the code documentation ↔︎ Dev Committee #260

• Clarify options for configuration and/or customization of a module ↔︎ Dev Committee #274 and #288

Validate and Integrate finished Projects from https://openimis.atlassian.net/wiki/spaces/OP/pages/2058879051 into Documentation (Architecture)

Document Release Management into Documentation

• Step by step deliverables / check-list (integrate pull-requests, update doku, update modules overview) ->https://openimis.atlassian.net/wiki/spaces/OP/pages/3312615490

Update https://openimis.atlassian.net/wiki/spaces/OP/pages/368508929 for https://openimis.atlassian.net/l/c/9WjwwJwE and optimize accessibility

Integrate https://openimis.atlassian.net/wiki/spaces/OP/pages/368508929 into Releases

Merge / move / clean up https://openimis.atlassian.net/wiki/pages/createpage.action?spaceKey=op&title=Release%20notes&linkCreation=true&fromPageId=3276505089 into Releases

Setup / optimize a documentation update process (checklist) to ensure the documentation improves in a timely and parallel way

How to document architecture: Graphics: repository for architecture etc done with draw.io

• https://openimis.atlassian.net/wiki/spaces/SB/pages/3244916739

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 explicitly “openIMIS” everywhere or nowhere

Include Domain Knowledge into Wiki Target Structure [Draft]

Setup Process for Transform Product Owner / Incubator Knowledge to Documentation

Setup Framework to Improve Recording, Documentation and Publishing of Webinars

• Enable the process to be started externally (e.g. per Jira queue)

https://openimis.atlassian.net/wiki/spaces/OP/pages/2161148020

Sandbox Server access / root account

Consolidate server hosting credentials, migration of DNS host and access sharing strategies -> Server Administration & Accounts

Clean up https://openimis.atlassian.net/wiki/spaces/OP/pages/3316285449

Keypass keyrings:

• Admin (on internal teams channel)

• Others on demand

Server contract login (Keypass keyring)

Web-page - Wiki links: https://openimis.atlassian.net/wiki/spaces/SB/pages/1025015809

Remove / document / avoid content redundancies between web and wiki

Make sure the transition from web to Wiki is smooth (especially for first time users)

Clean up Teams channels (List, messages, export)

Analyze back-links from Wiki to Web - e.g. https://openimis.atlassian.net/wiki/spaces/OP/pages/2058715159 (and other implementations) refers to http://openimis.org/tanzania on the web

Publish relevant Events on Web

Remove https://openimis.atlassian.net/wiki/pages/createpage.action?spaceKey=op&title=%5Bdelete%5D%20Welcome%20to%20the%20openIMIS%20Initiative%21&linkCreation=true&fromPageId=3276505089 and other redundant content after launch of new version of Web

Separate static from temporal content

Remove and avoid redundancies