Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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. Cleanup and Integrate code and publishing management into Documentation

    1. Update Version management

    2. Update Contribution guidelines

    3. Update Extended Github workflow

    4. Integrate Updating all python modules CI github workflow into Knowledge Base

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

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

Conceptual notes

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. Update Sources for https://openimis.atlassian.net/l/c/9WjwwJwE and optimize accessibility

  3. Graphics: repository for architecture etc done with draw.io

    /wiki/spaces/SB/pages/3244916739

    Create dependency graph for openIMIS modules / repos in Documentation

  4. Cleanup and Integrate Modular Transformation (e.g. Target (modular) Architecture ) into Documentation

  5. Cleanup and Integrate Target Technology Stack into Documentation

  6. Cleanup and Integrate (new) openIMIS installations into Documentation

  7. Cleanup and Integrate JLN Process - OpenIMIS Mapping into Documentation

  8. Cleanup and Integrate openIMIS Database Design into Documentation

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

Release

  1. Document Release Management into Documentation

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

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

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

  4. Mark/Remove/Hide deprecated GitHub reposUpdate Sources for https://openimis.atlassian.net/l/c/9WjwwJwE and optimize accessibility

  5. Integrate Sources into Releases

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

  7. Integrate Sources into Releases

  8. Update Developer Starter Kit for Release 2022-04

  9. Update Installation guide for Release 2022-04

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

  11. Cleanup and Integrate Modular Transformation (e.g. Target (modular) Architecture ) into Documentation

  12. Cleanup and Integrate Target Technology Stack into Documentation

Documentation Methodology

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

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

  3. Cleanup and Integrate code and publishing management into Documentation

    1. Update Version management

    2. Update Contribution guidelines

    3. Update Extended Github workflow

    4. Integrate Updating all python modules CI github workflow into Knowledge Base

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

  4. Cleanup and Integrate (new) openIMIS installations into Documentation

  5. Cleanup and Integrate JLN Process - OpenIMIS Mapping into Documentation

  6. Cleanup and Integrate openIMIS Database Design into Documentation Cleanup and Integrate further mature/not-in-development content into Documentation

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

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

  9. Update and Integrate Use cases served by openIMIS - overview into Documentation

  10. Standardize naming in Knowledge Base “How to” etc. …

  11. Standardize naming in openIMIS Product substructure explicitely “openIMIS” everywhere or nowhereCreate dependency graph for openIMIS modules / repos in Documentation

Internal Documentation (under Maintenance Contract Project: 2020.T1 Maintenance )

...