Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

I updated Appendix C: Troubleshooting. #15

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file added assets/Troubleshooting_Design_Flowchart.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Troubleshooting_Development_Flowchart.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/troubleshootingflowchart.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 41 additions & 2 deletions en/Appendices/appendixC.md
@@ -1,5 +1,44 @@
<center><h1>Appendix C: Troubleshooting</h1></center>

*********************************************

![Troubleshooting Flow Chart](/assets/troubleshootingflowchart.png)
<center>Troubleshooting Flow Chart
## What to do when generally confused:

* Read through the developer's manual
* Read the introductory pages in the wiki
* Search OpenMRS Talk for questions similar to your own

# Purpose: Supplementary info for the visualization

## How to utilize OpenMRS Talk:
* Head to the [OpenMRS Talk](https://talk.openmrs.org/) page and search for a topic related to your issue. If there is not a related topic, create a new topic by selecting the “New Topic” button in the top right corner of the page.

## Propose as a topic for a design forum:
* To propose a new topic, reply to the [“Propose a Design Forum Topic”](https://talk.openmrs.org/t/propose-a-design-forum-topic/11596), including in your reply a title for the topic, a description of the topic, any required attendees for the call to be productive, and a desired timing. For more information on what design forums are and when they happen, head to the [Design Forum Documentation](https://wiki.openmrs.org/display/RES/Design+Forum) in the OpenMRS Wiki.

## How to utilize IRC:
* To connect to IRC, go to the [OpenMRS IRC Wiki page](https://wiki.openmrs.org/display/IRC/Home) and connect via the window within the wiki page. For tips on how to use IRC, head to the [IRC help page](http://www.irchelp.org/faq/irctutorial.html) for tutorials.

## Creating a JIRA Ticket:
* To create a JIRA ticket, go to the [OpenMRS Issues page](https://issues.openmrs.org/secure/Dashboard.jspa) and login to your OpenMRS account. If you do not have an account, you will not be able to add a ticket. Once logged in, select the “Create” button at the top of the page to start the process of creating a new ticket.


## Helpful Links:

[Introductory Pages](https://wiki.openmrs.org/display/docs/Introduction+to+OpenMRS)

[Sign up for OpenMRS ID](https://id.openmrs.org/)

[OpenMRS Talk](https://talk.openmrs.org)

[How to use OpenMRS Talk with Email](https://talk.openmrs.org/t/openmrs-talk-email-discussion-groups/1165)

[OpenMRS IRC](https://wiki.openmrs.org/display/IRC/Home)

[World of OpenMRS](https://openmrs.org/join-the-community/)

[Code of Conduct](https://wiki.openmrs.org/display/docs/Code+of+Conduct)

[What is Model-View-Controller (MVC)?](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller)

[What is an Open Web App (OWA)?](https://wiki.openmrs.org/display/docs/Open+Web+Apps+Module)
23 changes: 23 additions & 0 deletions en/Appendices/appendixC/requirements-and-design.md
@@ -0,0 +1,23 @@
<center><h1>Requirements and Design Troubleshooting</h1></center>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you look at the preview of this?

*********************************************

![](/assets/Troubleshooting_Design_Flowchart.png)

<center>Troubleshooting Flow Chart</center>

## Helpful Links:

[OpenMRS IRC](https://wiki.openmrs.org/display/IRC/Home)

[OpenMRS Talk](https://talk.openmrs.org)

[How to use OpenMRS Talk with Email](https://talk.openmrs.org/t/openmrs-talk-email-discussion-groups/1165)

[OpenMRS Design Forum](https://wiki.openmrs.org/display/RES/Design+Forum)

[Understanding Issues](https://wiki.openmrs.org/display/docs/Tickets)

[OpenMRS Issues](https://issues.openmrs.org/secure/Dashboard.jspa)


@@ -0,0 +1,24 @@
<center><h1>Software and Development Troubleshooting</h1></center>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you look at the preview of this?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I have looked at a preview of the file, and it appears as intended. If you click "Display the rich diff" it displays the markdown file without the .png file included. If you click the three dots to the right of that option, and select "View file" from the drop-down, the markdown file will display as intended, with the .png file included.

*********************************************

![](/assets/Troubleshooting_Development_Flowchart.png)

<center>Troubleshooting Flow Chart</center>

## Helpful Links:

[OpenMRS IRC](https://wiki.openmrs.org/display/IRC/Home)

[OpenMRS Talk](https://talk.openmrs.org)

[How to use OpenMRS Talk with Email](https://talk.openmrs.org/t/openmrs-talk-email-discussion-groups/1165)

[Software Installation](https://wiki.openmrs.org/display/docs/Step%20by%20Step%20Installation%20for%20Developers)

[World of OpenMRS](https://openmrs.org/join-the-community/)

[Rubber Duck Debugging](https://en.wikipedia.org/wiki/Rubber_duck_debugging)

[Pair Programming](https://wiki.openmrs.org/display/docs/Pair+Programming)

8 changes: 5 additions & 3 deletions en/SUMMARY.md
Expand Up @@ -15,8 +15,10 @@
* [Get Support](What_next/getSupport.md)
* [Developer Checklist](What_next/devChecklist.md)
* Appendices
* [Appendix A: Learning Resources](Appendices/appendixA.md)
* [Appendix B: OpenMRS Glossary](Appendices/appendixB.md)
* [Appendix C: Troubleshooting](Appendices/appendixC.md)
* [Appendix A: Learning Resources](Appendices/appendixA.md)
* [Appendix B: OpenMRS Glossary](Appendices/appendixB.md)
* [Appendix C: Troubleshooting](Appendices/appendixC.md)
* [Software and Development](Appendices/appendixC/software-and-development-troubleshooting.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be here?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I intentionally split the Troubleshooting appendix into two sub-directories. I left more general content in the main page of Appendix C.

* [Requirements and Design](Appendices/appendixC/requirements-and-design.md)
* [About This Book](about.md)