Merge pull request #24 from bmamlin/main

Convert to Retype documentation
openmrs · Sep 21, 2023 · 5f22633 · 5f22633
2 parents ae6563a + 8c2989f
commit 5f22633
Show file tree

Hide file tree

Showing 46 changed files with 142 additions and 145 deletions.
diff --git a/.github/workflows/retype-action.yml b/.github/workflows/retype-action.yml
@@ -0,0 +1,24 @@
+name: Publish Retype powered website to GitHub Pages
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    name: Publish to retype branch
+
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: retypeapp/action-build@latest
+
+      - uses: retypeapp/action-github-pages@latest
+        with:
+          update-branch: true
diff --git a/.gitignore b/.gitignore
@@ -1,14 +1,2 @@
-# Node rules:
-## Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-## Dependency directory
-## Commenting this out is preferred by some people, see
-## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git
-node_modules
-
-# Book build output
-_book
-
 # Operating System noise
 .DS_Store
diff --git a/.travis.yml b/.travis.yml
diff --git a/Appendices/README.md b/Appendices/README.md
@@ -0,0 +1,3 @@
+---
+icon: book
+---
diff --git a/en/Appendices/appendixA.md → Appendices/appendixA.md b/en/Appendices/appendixA.md → Appendices/appendixA.md
@@ -1,5 +1,6 @@
-<center><h1>Appendix A: Learning Resources</h1></center>
-***************************************
+---
+title: Appendix A - Learning Resources
+---
 
 We've compiled these following list to give you more resources for some of the tools, technologies, and other aspects of working on OpenMRS. If you find a resource you'd like to add to this list, please let us know using comments or send an e-mail to [community@openmrs.org](mailto:community@openmrs.org).
 

diff --git a/en/Appendices/appendixB.md → Appendices/appendixB.md b/en/Appendices/appendixB.md → Appendices/appendixB.md
@@ -1,5 +1,6 @@
-<center><h1>Appendix B: OpenMRS Glossary</h1></center>
-*******************************
+---
+title: Appendix B - OpenMRS Glossary
+---
 
 **Allergy list:** A series of allergies from which a patient suffers.
 

diff --git a/Appendices/appendixC.md b/Appendices/appendixC.md
@@ -0,0 +1,5 @@
+---
+title: Appendix C - Troubleshooting
+---
+
+![Troubleshooting Flow Chart](/assets/troubleshootingflowchart.png)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-<center><img src="/assets/OpenMRS-cross.png"></center>
+![](/assets/OpenMRS-cross.png)
 <center><h1> Welcome To OpenMRS </h1></center>
 <center><h2> Write Code, Save Lives </h2></center>
 

diff --git a/en/Case_study/yourFirstModule.md → Case_study/yourFirstModule.md b/en/Case_study/yourFirstModule.md → Case_study/yourFirstModule.md
@@ -1,5 +1,6 @@
-<center><h1>Creating Your First Module</h1></center>
-************************************
+---
+title: Creating Your First Module
+---
 
 ## Amani Clinic Case Study
 

diff --git a/en/Community/collaborationTools.md → Community/collaborationTools.md b/en/Community/collaborationTools.md → Community/collaborationTools.md
@@ -1,8 +1,12 @@
-<center><h1>Collaboration Tools</h1></center>
-**************************************
-<center><img src="/assets/Collaboration Tools.jpg"><center> _2013 OpenMRS Implementers Meeting, Eldoret, Kenya_
+---
+title: Collaboration Tools
+---
 
-##Tools and Tips
+![_2013 OpenMRS Implementers Meeting, Eldoret, Kenya_](/assets/collaboration-tools.jpg)
+
+----
+
+## Tools and Tips
 
 In the previous section, we examined some ways to work together in the OpenMRS community. This section will explore some of the tools we use to do so. We have many different ways we can work with one another. Our main collaborative tools include:
 

diff --git a/en/Community/workingCooperatively.md → Community/workingCooperatively.md b/en/Community/workingCooperatively.md → Community/workingCooperatively.md
@@ -1,6 +1,10 @@
-<center><h1>Working Cooperatively</h1></center>
-********************************************
-<center><img src="/assets/Working Cooperatively.jpg"><center> _OpenMRS design brainstorming session, October 2013_
+---
+title: Working Cooperatively
+---
+
+![_OpenMRS design brainstorming session October 2013_](/assets/working-cooperatively.jpg)
+
+----
 
 ## Getting Things Done
 

diff --git a/en/Kick_off/brief_background_of_health_it.md → Kick_off/brief_background_of_health_it.md b/en/Kick_off/brief_background_of_health_it.md → Kick_off/brief_background_of_health_it.md
@@ -1,48 +1,48 @@
-<center><h1>Brief Background of Health IT &amp; Need for Health IT</h1></center>
-
-********************************************************
+---
+title: Brief Background of Health IT &amp; Need for Health IT
+---
 
 Before you get started as a developer in the OpenMRS project, you may find it useful to learn just a brief background of Health IT, what it is, and why it matters.
 
 For many years, Health IT applications have been created and used to effectively record and manage patient medical records. Traditionally, patient data were recorded in paper records. However, advances in the field of medicine are introducing the need to manage very large amounts of data. Because paper medical records are inherently passive, they can not evaluate or trigger meaningful actions in response to their content. These challenges led to the development of many different[ **Electronic Medical Record** (EMR)](https://en.wikipedia.org/wiki/Electronic_health_record) systems. These software tools promote meaningful use of patient health records.
 
 Over the past several decades, several commercial and [open source EMR](https://en.wikipedia.org/wiki/OpenEMR) tools have been developed and implemented with varied levels of success. OpenMRS is one of them!
 
-<center><img src="/assets/Story of OpenMRS.jpg"></center>
+![](/assets/Story-of-OpenMRS.jpg)
 
  *Patient registration clerks using OpenMRS*
 
 ## Improving Health Care Quality
 
 EMRs *like OpenMRS* can help improve the quality of healthcare in multiple ways.
 
-####  1. Accuracy
+###  1. Accuracy
 
 The adoption of health IT can significantly reduce the potential for medical errors. For example, an EMR can resolve incidents where hand-written physician records are misinterpreted, and incorrect medication provided to a patient.
 
-#### 2. Efficiency
+### 2. Efficiency
 
 EMR systems can improve the efficiency of data exchange between multiple health IT applications. They can also prevent duplication of services, thereby reducing chances of unnecessarily extending a patient's hospital stay and maximizing use of hospital resources.
 
-#### 3. Better Patient Care
+### 3. Better Patient Care
 
 Data collected by an EMR application can be used to support decision-making by health care professionals. Computerized guidelines can also offer benefits to help clinicians and patients make better decisions, thereby increasing the likelihood that health care decisions have a positive outcome on the patient.
 
-#### 4. Understanding Data About Public Health
+### 4. Understanding Data About Public Health
 
 The data captured via an EMR system can be used to explore data used to create and monitor public health standards. For example, vaccination records stored in an EMR can provide a deep insight into the population of a state or country, and the health of those vaccinated people over time.
 
-#### 5. Serving As a Record of Patient Care
+### 5. Serving As a Record of Patient Care
 
 Patient data recorded in an EMR system can serve as a historical record of patient care, and is usable both as a legal record as well as a means of evaluating the quality of health care provided. For example, patient records in an EMR system that record health care activities at a certain location can be transferred to another location when that patient moves somewhere else. The information provided to the new physician can be re-used to assess a patient's health condition.
 
 ## Challenges of Maintaining EMR's
 
-#### 1. The Need For Standardized Clinical Terminology
+### 1. The Need For Standardized Clinical Terminology
 
 Both variation in terms used by health care professionals and a general lack of standardization, have both had a significant impact on the meaningful use of health IT applications. For example, a clinician in one wing of the hospital might use the term "heart attack", while another in a different department might use the term "myocardial infarction" to refer to the same thing. This lack of standardization reduces the quality and usefulness of the data. The most common way to handle this problem is use of **standardized medical terminology.**
 
-#### 2. Data Privacy, Confidentiality And Security Issues
+### 2. Data Privacy, Confidentiality And Security Issues
 
 Given the significance of medical data, it is extremely important that confidentiality of patient records are ensured at all times, and that access to these records is strictly controlled and is only given to relevant users. For example, different types of EMR users may only require access to certain types of data or metadata, based on their roles in the health care facility.
 

diff --git a/en/Kick_off/openmrs_today.md → Kick_off/openmrs_today.md b/en/Kick_off/openmrs_today.md → Kick_off/openmrs_today.md
@@ -1,7 +1,9 @@
-<center><h1>OpenMRS Today</h1></center>
-********************************************************
+---
+title: OpenMRS Today
+---
+![_OpenMRS Atlas, October 2016_](/assets/openmrs_atlas_2016.png)
 
-<center><img src="/assets/openmrs_atlas_2016.png"></center> _ OpenMRS Atlas, October 2016 _
+----
 
 ## A Snapshot
 

diff --git a/...he_health_it_challenges_our_responsemd.md → ..._the_health_it_challenges_our_response.md b/...he_health_it_challenges_our_responsemd.md → ..._the_health_it_challenges_our_response.md
@@ -1,6 +1,4 @@
-<center><h1>Solving the Health IT Challenges (Our Response)</h1></center>
-*********************************************************
-<center><img src="/assets/AMPATH-2004.png"><center> _ AMPATH Clinic, Eldoret, Kenya, ca. 2004 _
+![_AMPATH Clinic, Eldoret, Kenya, ca. 2004_](/assets/AMPATH-2004.png)
 
 OpenMRS was conceived in 2004 specifically to solve the problem of managing health care information in the developing world. Today, connectivity and accessibility are critical pieces for health information systems. In most countries, this information is still in silos and is not accessible to those who need it—patients, clinicians, researchers, epidemiologists, and planners. Based on best practices and institutional knowledge from founding partners **Regenstrief Institute &amp; Partners In Health**.
 The goal of OpenMRS was to become a platform that could be flexible enough for use in a variety of contexts in settings that had very different requirements.

diff --git a/LANGS.md b/LANGS.md
diff --git a/README.md b/README.md
@@ -1,12 +1,17 @@
-<center><img src="/assets/OpenMRS-cross.png"></center>
+![](/assets/OpenMRS-cross.png)
 <center><h1> Welcome To OpenMRS </h1></center>
 <center><h2> Write Code, Save Lives.</h2></center>
 
 This is the OpenMRS Developer Manual. It is an electronic book meant to serve as an introduction to [OpenMRS](https://openmrs.org) Development.
 
+!!!
+**NOTE**: The guide was written for OpenMRS 1.9 in 2012 and needs to be updated. We would appreciate any help in updating the 
+developer manual to make it more relevant. For OpenMRS 3 frontend development, please see [om.rs/o3docs](https://om.rs/o3docs)
+!!!
+
 ### View the Book
 
-You can view or download the manual at http://om.rs/devmanual ([PDF](http://om.rs/devmanualpdf))
+You can view or download the manual at http://om.rs/devmanual
 
 ### Book Source on GitHub
 

diff --git a/en/SUMMARY.md → SUMMARY.md b/en/SUMMARY.md → SUMMARY.md
@@ -1,8 +1,8 @@
 # Summary
 
-* [Introduction](README.md)
+* [Introduction](introduction.md)
 * [Brief Background of Health IT](Kick_off/brief_background_of_health_it.md)
-* [Solving the Health IT Challenges](Kick_off/solving_the_health_it_challenges_our_responsemd.md)
+* [Solving the Health IT Challenges](Kick_off/solving_the_health_it_challenges_our_response.md)
 * [OpenMRS Today](Kick_off/openmrs_today.md)
 * [Working Cooperatively](Community/workingCooperatively.md)
 * [Collaboration Tools](Community/collaborationTools.md)
@@ -14,9 +14,9 @@
 * [Get Involved](What_next/getInvolved.md)
 * [Get Support](What_next/getSupport.md)
 * [Developer Checklist](What_next/devChecklist.md)
-* Appendices
+* [Appendices](Appendices/README.md)
    * [Appendix A: Learning Resources](Appendices/appendixA.md)
    * [Appendix B: OpenMRS Glossary](Appendices/appendixB.md)
    * [Appendix C: Troubleshooting](Appendices/appendixC.md)
-* [About This Book](about.md)
+* [About This Book](about-this-book.md)
 
diff --git a/en/Technology/architecture.md → Technology/architecture.md b/en/Technology/architecture.md → Technology/architecture.md
@@ -1,5 +1,3 @@
-<center><h1>Architecture</h1></center>
-*******************************************
 
 This chapter contains an in-depth view of the architecture of the system. If you don't understand everything on the first reading, don't fret! Understanding how the basic system fits together is the most important thing you need for now.
 

diff --git a/en/Technology/dataModel.md → Technology/dataModel.md b/en/Technology/dataModel.md → Technology/dataModel.md
@@ -1,7 +1,8 @@
-<center><h1>Data Model</h1></center>
-*****************************
-<center><img src="/assets/openmrs_data_model_1.9.0_small.png"></center>
-_OpenMRS data model version 1.9. Details at http://om.rs/datamodel_
+---
+title: Data Model
+---
+
+![_OpenMRS data model version 1.9. Details at http://om.rs/datamodel_](/assets/openmrs_data_model_1.9.0_small.png)
 
 OpenMRS invests continuous effort into shaping the OpenMRS data model using knowledge and experience gathered from practical experiences from the Regenstrief Institute, Partners in Health, and all of our development partners spread across the world. The core of this data model addresses the who, what, when, where, and how of medical encounters. The core data model is divided into ten basic domains.
 

diff --git a/en/Technology/developmentProcess.md → Technology/developmentProcess.md b/en/Technology/developmentProcess.md → Technology/developmentProcess.md
@@ -1,5 +1,6 @@
-<center><h1>Development Process</h1>
-************************************
+---
+title: Development Process
+---
 
 ## Selecting Development Work
 

diff --git a/en/Technology/getSetUp.md → Technology/getSetUp.md b/en/Technology/getSetUp.md → Technology/getSetUp.md
@@ -1,6 +1,10 @@
-<center><h1>Setting Up </h1></center>
-**********
-<center><img src="/assets/Get Set Up.jpg"></center>
+---
+title: Setting Up
+---
+
+![](/assets/get-set-up.jpg)
+
+----
 
 Now that we know all of the background and support information, let's set up a basic install of OpenMRS on your system!
 

diff --git a/en/What_next/devChecklist.md → What_next/devChecklist.md b/en/What_next/devChecklist.md → What_next/devChecklist.md
@@ -1,11 +1,12 @@
-<center><h1>Developer Checklist</h1></center>
-************************************
+---
+title: Developer Checklist
+---
 
 The OpenMRS community actively encourages members to grow as contributors by taking up more advanced roles within the community. Many of our dedicated volunteers began by working on introductory tickets, and went on to become senior contributors within the community, working on a wide range of tasks from core OpenMRS development to working on individual implementations.
 
 The following checklist signifies potential milestones which a developer may follow. Note that these are very generic guidelines, with no strict timelines or strict order of precedence. Rather, they serve as inspiration for potential options available to all community members.
 
-<center><h4> OpenMRS Developer Checklist 
+## OpenMRS Developer Checklist 
 
 |#| Goal |
 |--|:-----|

diff --git a/en/What_next/getInvolved.md → What_next/getInvolved.md b/en/What_next/getInvolved.md → What_next/getInvolved.md
@@ -1,6 +1,8 @@
-<center><h1>Get Involved</h1></center>
-******************************
-<center><img src="/assets/OpenMRS Community.jpg"></center> _The OpenMRS Community, Circa 2013_
+---
+title: Get Involved
+---
+
+![_The OpenMRS Community, Circa 2013_](/assets/OpenMRS-Community.jpg)
 
 Now that you understand the basics of OpenMRS development, you can do a lot or you can do a little. How deep you dive into the OpenMRS community is up to you! Keep in mind that someone may want to pick up your work where you leave off, so be sure to document everything as you go along. 
 

diff --git a/en/What_next/getSupport.md → What_next/getSupport.md b/en/What_next/getSupport.md → What_next/getSupport.md
diff --git a/en/about.md → about-this-book.md b/en/about.md → about-this-book.md
@@ -1,12 +1,11 @@
-<center><h1>About this book</h1></center>
-***************************************
-
 This book was initially created over just 3 days during the 2013 [Google Summer of Code](https://summerofcode.withgoogle.com) Doc Sprints held at the Google campus in Mountain View, California, United States.
 
 The event was a partnership between the Google Open Source Programs Office, Aspiration, and FLOSS Manuals. The initial authors of this book represented a wide variety of OpenMRS community members &amp; developers (Michael Downey, Eric Holscher, Suranga Nath Kasthurirathne, Daniel Kayiwa, Jordan Kellerstrass, and Elyse Voegeli from United States, Sri Lanka, and Uganda). Photos used in this book are courtesy of Michael Downey and OpenMRS, Inc.
 
 In 2016, this book was translated into GitBook format during [Google Code-in](https://developers.google.com/open-source/gci/) and migrated to GitHub.
 
+In 2023, this book was translated into [Retype](https://retype.com/) format.
+
 ### Contribute
 
-This book is hosted on [GitHub](https://github.com/openmrs/openmrs-book-guide) and your are welcome and encouraged to [help us improve it](https://github.com/openmrs/openmrs-book-guide/blob/master/CONTRIBUTING.md)!
+This book is hosted on [GitHub](https://github.com/openmrs/openmrs-book-developer-manual) and your are welcome and encouraged to [help us improve it](CONTRIBUTING.md)!
diff --git a/assets/OpenMRS Community.jpg → assets/OpenMRS-Community.jpg b/assets/OpenMRS Community.jpg → assets/OpenMRS-Community.jpg
diff --git a/assets/Story of OpenMRS.jpg → assets/Story-of-OpenMRS.jpg b/assets/Story of OpenMRS.jpg → assets/Story-of-OpenMRS.jpg
diff --git a/assets/Collaboration Tools.jpg → assets/collaboration-tools.jpg b/assets/Collaboration Tools.jpg → assets/collaboration-tools.jpg
diff --git a/assets/Get Set Up.jpg → assets/get-set-up.jpg b/assets/Get Set Up.jpg → assets/get-set-up.jpg
diff --git a/assets/Working Cooperatively.jpg → assets/working-cooperatively.jpg b/assets/Working Cooperatively.jpg → assets/working-cooperatively.jpg
diff --git a/book.json b/book.json