Documentation System & Roadmap - Githubissues

dhis2 / notes

:memo: Memos, proposals, agendas and meeting minutes

19 stars 8 forks source link

Documentation System & Roadmap #109

Closed amcgee closed 3 years ago

amcgee commented 4 years ago

The documentation system

Hosted at developers.dhis2.org (adapted from the divio documentation system)

Type	Orientation	Goals	Useful while
Concept	Understanding	Get a broad overview of the system Understand why design decisions were made	Learning
Tutorial	Learning	Get started with the tools (from zero)	Learning
Guide	Problem	Solve a specific problem (from non-zero)	Working
Reference	Information	Exhaustive API specifications	Working

Some Guide ideas (no particular order)

How to build a library with the Application Platform
How to fetch data from a DHIS2 instance
How to test my application for a specific DHIS2 version (with d2 cluster)
How to add a DHIS2 UI Button to my application
How to add a DHIS2 Org Unit Tree selector to my application
How to add translation support to an application
How to add page routing to an application
How to add global state to an application
How to use a sidebar layout in my application
How to save and restore user settings in my application
How to save and load "visualization" objects in my application
How to embed a plugin in my application
How to build a dashboard plugin
How to write automated tests for my application
How to submit an application to the DHIS2 App Hub

amcgee commented 4 years ago

CC @awgaan for any additional topics I missed