diff --git a/README.md b/README.md index 083654c..f30d4d0 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,64 @@ +!!!warning 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) +!!! + ![](/assets/OpenMRS-cross.png) -

Welcome To OpenMRS

-

Write Code, Save Lives.

+

Welcome To OpenMRS

+

Write Code, Save Lives

+ +---- + +Thank you for your interest in the [OpenMRS Community!](http://openmrs.org/join-the-community/) We have created this book for people who are curious about becoming a developer using our software. This book serves as a quick guide for you to learn more about our history, what [OpenMRS does,](http://openmrs.org/about/mission/) and understand more about how our community works. + +If you find yourself eager to get started, we've also included some practical advice on specific steps you can take right away to start doing development with the OpenMRS platform. + +#### This is _your_ book! -This is the OpenMRS Developer Manual. It is an electronic book meant to serve as an introduction to [OpenMRS](https://openmrs.org) Development. +As with much of free and open source software, what you're reading is a **"living" and evolving resource!** !!! -**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) +You can contribute to this book simply by scrolling to the bottom of any page and clicking the "Edit this page" link. !!! -### View the Book +We welcome your feedback on this book. We want to know if it helps you get started as an OpenMRS developer, and what might be missing. Read about [contributing](CONTRIBUTING.md) to learn how to use the GitBook editor to make change requests via GitHub pull requests. If you are not up for proposing edits, you can send your feedback to [community@openmrs.org](mailto:community@openmrs.org) or bring it up on [OpenMRS Talk](https://talk.openmrs.org/). We're ready to use your comments and input as we update this resource. -You can view or download the manual at http://om.rs/devmanual +### Who Should Read This Book -### Book Source on GitHub +Who are you exactly? We assume you are a software developer who is new to OpenMRS and someone who wants to learn more about the project and community that is OpenMRS. You're someone who shares our values and believes in our mission to improve health care delivery in resource-constrained environments by coordinating a global community to create and support this software. You're someone who wants to become a member of our community. -OpenMRS is open source. That means anyone in the world can help improve the code. Likewise, this electronic book is open source as well, meaning anyone is welcome to help improve the Developer Manual too (see below on how to contribute)! The source for this book is hosted on GitHub. +If you are not a developer and are more interested in implementation or a high level overview, then you may be more interested in the [OpenMRS Implementer Guide](http://guide.openmrs.org). -[openmrs/openmrs-book-developer-manual](https://github.com/openmrs/openmrs-book-developer-manual) +**Being New to OpenMRS Can Mean Different Things For Different People:** -### Contribute +* You might be new to software development. +* You might be new to free and open source software projects. +* You might be new to health IT. +* You might just be new to OpenMRS specifically. -People using the OpenMRS Developer Manual are likely to be in the best position to help improve the manual. Whether you have discovered an error or you have some ideas on how the book could be improved, we welcome your input. Help us improve this manual by [contributing](CONTRIBUTING.md) to it! +Regardless of what you know or how much you need to know, this book is designed for you! +### What You Will Gain +This book is designed to give you the knowledge, tools, and confidence to be an OpenMRS developer, no matter from which point you're starting. We'll give you a background and brief [history of OpenMRS](https://en.wikipedia.org/wiki/OpenMRS#History). We'll also talk about where we are now, and how we are working together to change the world. +**At The End of This Book, You Should:** + +* Understand how the OpenMRS community interacts and communicates +* Have a development environment setup +* Understand the basics of the OpenMRS system +* Be able to troubleshoot OpenMRS with resources in the community. +* Know where to go to get started with your first contributions to the community. + +!!!success +By the end of this book, you'll be an OpenMRS developer, contributor, and community member! +!!! + +!!!warning 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) +!!! diff --git a/README.yml b/README.yml new file mode 100644 index 0000000..12ef178 --- /dev/null +++ b/README.yml @@ -0,0 +1,2 @@ +Title: Introduction +icon: home \ No newline at end of file diff --git a/SUMMARY.md b/SUMMARY.md index b741ae4..d0f699a 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,6 +1,6 @@ # Summary -* [Introduction](introduction.md) +* [Introduction](README.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_response.md) * [OpenMRS Today](Kick_off/openmrs_today.md) diff --git a/about-this-book.md b/about-this-book.md index b319cf1..70e4939 100644 --- a/about-this-book.md +++ b/about-this-book.md @@ -11,4 +11,11 @@ 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-developer-manual) and your are welcome and encouraged to [help us improve it](CONTRIBUTING.md)! \ No newline at end of file +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)! + +!!!warning 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) +!!! \ No newline at end of file diff --git a/introduction.md b/introduction.md deleted file mode 100644 index e33dfac..0000000 --- a/introduction.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -icon: home ---- -![](/assets/OpenMRS-cross.png) -

Welcome To OpenMRS

-

Write Code, Save Lives

- ----- - -Thank you for your interest in the [OpenMRS Community!](http://openmrs.org/join-the-community/) We have created this book for people who are curious about becoming a developer using our software. This book serves as a quick guide for you to learn more about our history, what [OpenMRS does,](http://openmrs.org/about/mission/) and understand more about how our community works. - -If you find yourself eager to get started, we've also included some practical advice on specific steps you can take right away to start doing development with the OpenMRS platform. - -#### This is _your_ book! - -!!! -**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) -!!! - -As with much of free and open source software, what you're reading is a **"living" and evolving resource!** - -> **You can contribute to this book simply by scrolling to the top of any page and clicking the "EDIT" link.** - -We welcome your feedback on this book. We want to know if it helps you get started as an OpenMRS developer, and what might be missing. Read about [contributing](https://github.com/openmrs/openmrs-book-developer-manual/blob/master/CONTRIBUTING.md) to learn how to use the GitBook editor to make change requests via GitHub pull requests. If you are not up for proposing edits, you can send your feedback to [community@openmrs.org](mailto:community@openmrs.org) or bring it up on [OpenMRS Talk](https://talk.openmrs.org/). We're ready to use your comments and input as we update this resource. - -### Who Should Read This Book - -Who are you exactly? We assume you are a software developer who is new to OpenMRS and someone who wants to learn more about the project and community that is OpenMRS. You're someone who shares our values and believes in our mission to improve health care delivery in resource-constrained environments by coordinating a global community to create and support this software. You're someone who wants to become a member of our community. - -If you are not a developer and are more interested in implementation or a high level overview, then you may be more interested in the [OpenMRS Implementer Guide](http://guide.openmrs.org). - -**Being New to OpenMRS Can Mean Different Things For Different People:** - -* You might be new to software development. -* You might be new to free and open source software projects. -* You might be new to health IT. -* You might just be new to OpenMRS specifically. - -Regardless of what you know or how much you need to know, this book is designed for you! - -### What You Will Gain - -This book is designed to give you the knowledge, tools, and confidence to be an OpenMRS developer, no matter from which point you're starting. We'll give you a background and brief [history of OpenMRS](https://en.wikipedia.org/wiki/OpenMRS#History). We'll also talk about where we are now, and how we are working together to change the world. - -**At The End of This Book, You Should:** - -* Understand how the OpenMRS community interacts and communicates -* Have a development environment setup -* Understand the basics of the OpenMRS system -* Be able to troubleshoot OpenMRS with resources in the community. -* Know where to go to get started with your first contributions to the community. - -> By the end of this book, you'll be an OpenMRS developer, contributor, and community member! -