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

• Rework wiki “Space Shortcuts”

Wiki Target Structure

• openIMIS Product

  • Demo server / Sandbox Landscape

  • Releases

    • Release 2022-04

      • Sources Release 2022-04

      • Release notes

    • Release 2021-10

      • Sources Release 2021-10

      • Release notes

    • Release 2021-04

      • Sources Release 2021-04

      • Release notes

  • Installation guide

    • Requirements

      • Connectivity & theoretical infrastructure required

      • Resource requirements

      • Infrastructure security

    • Generic Implementation Starter Kit

    • Installation and Country Localisation

    • Configuration (choosing Modules)

    • Localisation / Translation Management platform

    • Customization (configuring/extending Modules)

    • Import tools

    • “How to migrate from Legacy to Modular” ↔︎ (see Modular Migration: Open Issues )

    • Training / YouTube

  • Architecture

    • Use cases served by openIMIS - overview

    • Target Technology Stack / (new) openIMIS installations

    • Modular Transformation / openIMIS Modules/ Target (modular) Architecture / https://docs.google.com/presentation/d/1eUqlOkK6MyTPZsQG3A8mZDzoIvFxzUtxi5r6UCVYYjc/edit#slide=id.g1192d288ca2_0_65 (slide 12)

      • The JLN Process Matrix

      • JLN Process - OpenIMIS Mapping

      • Dependency Graph for Modules / repos

    • openIMIS Database Design

    • openIMIS Integrations

    • /wiki/spaces/SB/pages/3244916739

  • Software Development

    • code and publishing management

      • Version management

      • Contribution guidelines

      • UI/UX Style Guide

      • Extended Github workflow

      • Updating all python modules CI github workflow

      • “Automated CI testing" of code and publishing management

      • Repository management (http://github.com / http://npmjs.com / http://pypi.org

    • Developer Starter Kit

    • Quality assurance

      • Testing

      • Security assessment template

    • Training / YouTube

  • Service Desk

    • Issue tracking

    • JIRA reports

  • Licenses

• openIMIS User

  • FAQ List

  • http://docs.openimis.org/en/latest/ / http://docs.openimis.org/fr/latest/

  • Training / YouTube

• openIMIS Development

  • Product Roadmap

  • Product Incubator

  • Opportunities

  • Project portfolio

  • https://openimis.atlassian.net/wiki/pages/resumedraft.action?draftId=40566854

• openIMIS Community

  • Meet our partners

  • Governance

  • Implementations

  • Communication

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-179 - Getting 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

Developers

Development guidelines

1. Update Developer Starter Kit for Release 2022-04

2. Update Installation guide for Release 2022-04

3. Create “Technical Requirements” page and fill with content e.g. Connectivity & theoretical infrastructure required

4. Validate and Integrate code and publishing management into Documentation

   1. Validate Version management

   2. Validate Contribution guidelines

   3. Validate Extended Github workflow

   4. Integrate Updating all python modules CI github workflow into Documentation

   5. Integrate “Automated CI testing" of code and publishing management into Documentation

5. Validate and integrate UI/UX Style Guide into Documentation

6. Validate YouTube content for Release 2022-04 / current development ↔︎ Dev Committee #176

Github

1. Clarify distribution of documention between GitHub repo and Wiki and remove redundancies

2. Clarify distribution of release notes between GitHub repo and Wiki and remove redundancies

3. Mark/Remove/Hide deprecated GitHub repos

Architecture

1. 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

2. Create dependency graph for openIMIS modules / repos in Documentation

3. Validate and Integrate Modular Transformation (e.g. Target (modular) Architecture ) into Documentation

4. Validate and Integrate Target Technology Stack into Documentation

5. Validate and Integrate (new) openIMIS installations into Documentation

6. Validate and Integrate JLN Process - OpenIMIS Mapping into Documentation

7. Validate and Integrate openIMIS Database Design into Documentation

8. Update each module in openIMIS Modules ↔︎ Dev Committee #260

9. Validate and Integrate finished Projects from Project portfolio into Documentation (Architecture)

Release

1. Document Release Management into Documentation

   • step by step deliverables / check-list (integrate pull-requests, update doku, update modules overview)

2. Update Sources for https://openimis.atlassian.net/l/c/9WjwwJwE and optimize accessibility

3. Integrate Sources into Releases

4. Merge / move / clean up Release notes into Releases

Documentation Methodology

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

   • /wiki/spaces/SB/pages/3244916739

2. Re-organize first level children of Documentation e.g. create and move content into our Technical Knowledge Base as “How-to”

3. Validate and Integrate further mature/not-in-development content into Documentation

4. Standardize naming in our Technical Knowledge Base “How to” etc. …

5. 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