medic / medic-docs

Replaced by https://github.com/medic/cht-docs. This repo was the former source of documentation for developing, configuring, and using Medic Mobile tools.
https://docs.communityhealthtoolkit.org
GNU Affero General Public License v3.0
29 stars 35 forks source link

Define documentation site functional requirements #193

Closed MaxDiz closed 4 years ago

MaxDiz commented 4 years ago

The CHT has an initial draft of the CHT documentation site (and GH repo) up and running. It uses Jekyll, primarily because of the built-in integration with Github Pages. The template is cumbersome, especially for the index, and not well suited to our needs. We are experiencing some challenges with layout, missing key functionality, etc, and have decided to explore alternative tooling options.

Documentation site requirements and priorities are below. Please add to this ticket

Easily navigable

Content types support

Embedded assistance - integrate with CHT technical support forum - disqus platform (very nice to have)

Information portability to complimentary platforms, and ownership/control (very nice to have)

Support for language translation (must have; open to 3rd party services)

Usable offline (nice to have)

Easy to contribute regardless of technical capabilities should be friendly for all team members to contribute. Github requires some training, but not insurmountable. Are there other good options to consider? (must have)

Single sign-on (OAuth) (very nice to have)

MaxDiz commented 4 years ago

@abbyad looking for your final review on this issue. It's a blocker to #196 which I would like to assign to a volunteer team member(s) tomorrow

abbyad commented 4 years ago

Looks good!

Adding a nice-to-have is matching or complementing existing CHT and/or Medic branding.