The Problem: So - we have a longstanding issue: There are a bunch of key topics/concepts that are helpful to know about OpenMRS, and can apply to any (sometimes all) of these 3 guides: (1) The Developer Guide, (2) Implementer Guide, (3) User & Admin Guide, etc.
Examples of some of the pages that we need to re-use in multiple guides:
Data Model & Architecture Overview
Forms
Translation
Concept / Dictionary Management
Reporting
The good news: The newest version of Confluence (which we now use) allows āSmart-Linksā, which enable you to have a page in multiple places, but itās not duplicated and any edits update the āMotherā version (feels kinda like an iFrame). So e.g. we can have the āFormsā guide in multiple places, without worrying about duplication, or it getting missed. Example here: You can see the Concept Guide is being pulled from elsewhere, but is still in a sensible spot in the Admin Guide.
Image showing how to add a Smart Linked page somewhere:
Time to Vote!
Proposal: In the Documentation Revival Squad weāve been talking about this issue. We propose having a single spot in the docs for āKey Topicsā like this, which we can then re-use (via Smart Links) in persona-specific guides. Hereās how such a page would look:
Iāve experimented with this in the Wiki to show what it can look like - have a look here
(Donāt worry, itās super simple to revert this if people donāt like it.)
Poll #1: What do you think of this idea?
Good idea
I have some concerns (Iāll share below)
I have BIG concerns (Iāll share below)
Poll #2: If you are ok with this idea, what should we call this section of the wiki?
- OpenMRS System: Key Topics
- OpenMRS System: Building Blocks
- OpenMRS System: Fundamentals
- OpenMRS System: Essentials
- OpenMRS System Overview
Looking forward to hearing what people think!