diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 2dac64824..d3baa7907 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -21,6 +21,7 @@ - [Translations](/main/translations.md) - [Breadcrumbs](/main/breadcrumbs.md) - [Creating a Distribution](/main/distribution.md) + - [FAQ](/main/faq.md) - Under the hood - [Architecture Overview](/under_the_hood/architecture.md) - [Tooling](/under_the_hood/tooling.md) diff --git a/docs/main/faq.md b/docs/main/faq.md new file mode 100644 index 000000000..6c2cf100c --- /dev/null +++ b/docs/main/faq.md @@ -0,0 +1,33 @@ +# Frequently Asked Questions + +### I'm not seeing the latest `@openmrs/esm-framework`. How do I update the dependency? + +In a repository using Yarn: + +``` +yarn upgrade @openmrs/esm-framework openmrs // to upgrade +git checkout package.json // to reset the version specifiers to 'next' +``` + +### How do I keep my local dev server up to date? + +Just pull the repository you want to work on and run `yarn` or `npm install`. +That will install the latest dependencies, which includes `openmrs`, which is +the tool that runs the dev server. + +### How do I find out where the code I need to work on is? + +There is no simple correlation between packages and pages and content. + +The first thing to check is the [list of repositories](http://o3-dev.docs.openmrs.org/#/main/map?id=repositories-you-should-know-octocat) +and their descriptions. There aren't very many, so it's likely you can +figure out what you're trying to work on just by looking at the list. + +If that doesn't work out, another trick is to clone all of the repositories +and then run `grep` across them to look for something you expect to find— +e.g. a piece of text from the UI. + +If you have done both of the above things and still haven't found the +code you're looking for, feel free to ask in the +[#openmrs-helpme](https://openmrs.slack.com/archives/C02UNMKFH8V) channel +on Slack.