Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack

Documentation

Page tree

Versions Compared

Key

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

We’ve researched and reached out to the community concerning their views. We’ve worked hard to understand the audience, their needs and how they will use our work. We proposed that the following are the potential persona's on of OpenMRS Documentation :

Our Proposed Process is as follows:

  1. Identify a page that needs editing . If you are not sure about a certain piece of content , post your question on talk to get more clarity from the community. You can copy the talk thread under the comments heading associated with the page on this wiki page so that community can keep track of the conversation.
  2. Post on the Wiki "Documentation Work Needed" page what you think the status of the page is (e.g. needs to be more detail, it needs to be deleted etc)
  3. Edit the page with the content that you feel is relevant/important.
  4. Post your completed page in the page statuses above with the link and comments where applicable
  5.  The Documentation team will review the edited page and request the Expert reviewer to review the page
  6. Once the page has been reviewed by the domain experts the pages is pushed to a completed page category



Feel free to add any step you feel is left out. Thanks for your support we meet 4pm EAT and 1pm UTC in cyber space.

The conference is open to everyone with our contribution focusing on New developer's guide and user guide.

Documentation Review Process 2019

Reviewers: Thank you for your help!  After selecting a page to review, please enter your name, review the changes and then enter "approved" or "needs work" into the status column(Including comments to direct any needed work.

Expert Review and Corrections

PAGE TITLEPAGE LINKCHANGES  MADEDESCRIPTION OF CHANGESREVIEWER(S)STATUSReviewer comments
For Open Web App DevelopersFor Open Web App Developers

View Changes


  • Added a detailed bulleted list of the page under the Quick Overview section
  • Added a practicality, architecture, dependencies, and tools section to the What is an OWA part
  • Added an MVC architecture diagram
  • Added how to install and create an OWA to the How To Write An OWA section
  • Added a how to edit an existing OWA to the How To Write An OWA section
  • Added three examples to the Examples section

Contributors:Maggie Harder Olivia RineSam NeupaneJacob Hansen

Suthagar Kailayapathy                                                         
Sign In to OpenMRSSign In to OpenMRS (Reference Application)Created new page for reference application

Added instructions and screenshot to reflect current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery.




Edit DemographicsEdit Demographics (Reference Application)Created new page for reference application

Added instructions and screenshot to reflect current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery.




Log OutLog Out (Reference Application)Created new page for reference application

Added instructions and screenshot to reflect current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery.




Forgot PasswordForgot Password (Reference Application)Created new page for reference application

Added instructions and screenshot to reflect current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery.




Create a PatientCreate a Patient (Reference Application)Created new page for reference application

Added instruction and screenshots to reflect the current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery




Patient OverviewPatient Overview (Reference Application)Created new page for reference application

Added instruction and screenshots to reflect the current state of reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery




Update Personal ProfileUpdate a Personal Profile (Reference Application)Created new page for reference application

Added instruction and screenshots to reflect the current state of the reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery




Set Up Secret QuestionSet Up a Secret Question and Answer (Reference Application)Created new page for reference application

Added instruction and screenshots to reflect the current state of the reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery




Dictionary Concept SearchDictionary Concept Search (Reference Application)Created new page for reference application

Added instruction and screenshots to reflect the current state of the reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery




Schedule AppointmentSchedule Appointment (Reference Application)

Added instruction and screenshots to reflect the current state of the reference application UI. Contributors: Chase Pearson Ryan Le Tristan Attebery




Order Entry End User Guide for Lab OrdersOrder Entry End User Guide for Lab OrdersView Changes

Added two new sections: Placing multiple lab orders and Discontinuing an active lab order. Also added additional detail to the Placing a lab order section. Contributors: Zachary Madsen Kevin Nguyen Logan Hellbusch youssef fathy



Using the Legacy UIUsing the Legacy UICreated a landing page for the legacy UI

This page should be updated to have a short description of the information contained within its sub-pages, mention that it pertains only to the legacyui, and link to the page with corresponding instructions for the reference application. Contributors: Chase Pearson Ryan Le Tristan Attebery




Using the Reference ApplicationUsing the Reference ApplicationCreated a landing page for the reference application

This page should be updated to have a short description of the information contained within its sub-pages, mention that it pertains only to the reference application, and link to the page with corresponding instructions for the legacyui. Contributors: Chase Pearson Ryan Le Tristan Attebery




ObsObsView Changes

This page has been populated to include information about the Obs object, its properties, and information about the ObsService including code snippets and an explanation of the methods included in each. This page is modeled after the Patients page.

Contributors: Colin Cummings Gage Zittler Matthew Sichterman



PersonPersonView Changes

This page has been populated to include information about the Person object, its properties, and information about the PersonService including code snippets and an explanation of the methods included in each. This page is modeled after the Patients page.

Contributors: Colin Cummings Gage Zittler Matthew Sichterman



UserUserView Changes

This page has been populated to include information about the User object, its properties, and information about the UserService including code snippets and an explanation of the methods included in each. This page is modeled after the Patients page.

Contributors: Colin Cummings Gage Zittler Matthew Sichterman



Open Web App Development WorkflowOpen Web App Development WorkflowView Changes

Adding missing information regarding AngularJS and React OWAs, with links to other useful resources. Chris Burbach Christian Berck Jacob Orellana



Administering

Modules

Administering ModulesView Changes

We will work to provide more detailed information about installing OMOD modules, along with additional information regarding installing OWA's. We will include visualizations and more clear install instructions. Contributors: Ethan ButtNick Kozisek Samir Kashyap Ben Morris

Status
colourGreen
titleapproved

Looks good. I wonder if making the images a little smaller might avoid introducing horizontal scrolling for some). I'll pose this question on Talk.
Developer How-To Setup And Use EclipseHow-To Setup and Use EclipseView Changes

List of Changes:

  • Updated all the images to reflect the most common version of Eclipse
  • Updated instructions to be more clear
  • Added instructions to have more detail to setup
  • Removed "Useful Plugins" section
  • Added some more requirements at the beginning to reflect the need for OpenMRS core and the SDK. 

Contributors: Adam GrayEaston JoachimsenConner Hallett

Daniel Kayiwa

Admin UI Module Admin UI ModuleView Changes

My team added more information about what the Admin UI module is, what files the module uses, what OpenMRS requirement is needed, download information, useful resources, and what developers were involved in the creation and maintenance of the module.

Contributors: Jessica Wheeler Adrian Pilkington Peyton Tanzillo Wyatt Chandler



Module Config File Config FileView Changes

My team added more information about configuration files as well as updated the progress being made on version 1.6. We are awaiting approval for our pull request, but we fixed the bug that was previously stated in the documentation and the talk thread. Contributors: Adrian Pilkington Jessica Wheeler Peyton Tanzillo Wyatt Chandler

Daniel Kayiwa

 Appointment Scheduling Module Appointment Scheduling ModuleView Changes

We cleaned up and reorganized the "Capabilities" section of the documentation. This section was previously named "Privileges". Along with this, we added screenshots to the previously empty "screenshots" section. We also added a brief instruction on how to add a new Appointment for first time users. Contributors include Anthony McIntoshAayush Khatiwada TyReesh BoedhramWilliam Prewitt



Unit TestingUnit TestingCreate new unit testing page under "For Open Web App Developers"

We added a new unit testing page under "For Open Web Apps Developers". This page talks about unit testing React and Angular OWAs. Contributors: Phillip Nguyen Parker Segal Hassan Abdelsamad AL FAROOQ SALTI





Appendix C: TroubleshootingTroubleshooting Flow Chart (Developer Manual)View Changes

We updated the visualization, rotating it and splitting it in two separate webs. Contributors Joe Carter Jack Rowen

needs work

I looked at the Troubleshooting Flow chart and had a hard time following your edits. I'm not a GitHub person!

From the documentation, it looks like you rotated, but it's still showing vertical instead of horizontal. Please correct this.

Also please include a section to define things like (IRC) and add notes, like the fact that you have to request permission to create a JIRA ticket.
Also, I would include the email address of the implementor and developer mailing list.

I would also include any links if possible to where the people are being referred (dev manual, OpenMRS calendar, etc.).

In the Wrong Place: pages that need to be moved (label: reorder)

PAGE TITLEPAGE LINKPAGE COMMENTS 
upgrading to platform 2.0Upgrading to Platform 2.0This page need to be moved to the right document
Prepare for upgrading from a pre-1.10 to 1.10 or latest versionPrepare for Upgrading From a Pre-1.10 to 1.10 or Later VersionThis page need to be moved to the right document






Pages that need more detail

PAGE TITLEPAGE LINKPAGE COMMENTS 
Developer manualhttp://devmanual.openmrs.org/en/

In the section of "Making your first Module", we need to add more details of "how to write test units" and "updating the messages.properties file" to give a better understanding to the new develper . Contributor Moses Mutesasira. Here is the PR for that . https://github.com/openmrs/openmrs-book-developer-manual/pull/12










Delete Pages

PAGE TITLEPAGE LINKPAGE COMMENTS 
  1.  Setting up an OpenMRS Client   
Setting up an OpenMRS Client      - No changes made  but inquiring if its of any value.