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

Add FAQ to docs #311

Merged
merged 1 commit into from
Feb 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
33 changes: 33 additions & 0 deletions docs/main/faq.md
Original file line number Diff line number Diff line change
@@ -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.