Skip to content

Commit b1e6111

Browse files
vorburgerMJ1998
vorburger
and
MJ1998
authored
Migrate Wiki to Docs (google#2546)
Co-authored-by: Madhuram Jajoo <[email protected]>
1 parent 4122bc9 commit b1e6111

40 files changed

+3806
-28
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Fixes #[issue number]
44

55
**Description**
6-
Clear and concise code change description.
6+
Clear and concise code change description.
77

88
**Alternative(s) considered**
99
Have you considered any alternatives? And if so, why have you chosen the approach in this PR?
@@ -14,8 +14,9 @@ Choose one: (Bug fix | Feature | Documentation | Testing | Code health | Builds
1414
**Screenshots (if applicable)**
1515

1616
**Checklist**
17+
1718
- [ ] I have read and acknowledged the [Code of conduct](https://github.com/google/android-fhir/blob/master/CODE_OF_CONDUCT.md).
18-
- [ ] I have read the [Contributing](https://github.com/google/android-fhir/wiki/Contributing) page.
19+
- [ ] I have read the [Contributing](https://google.github.io/android-fhir/contrib/) page.
1920
- [ ] I have signed the Google [Individual CLA](https://cla.developers.google.com/about/google-individual), or I am covered by my company's [Corporate CLA](https://cla.developers.google.com/about/google-corporate ).
2021
- [ ] I have discussed my proposed solution with code owners in the linked issue(s) and we have agreed upon the general approach.
2122
- [ ] I have run `./gradlew spotlessApply` and `./gradlew spotlessCheck` to check my code follows the style guide of this project.

‎.vscode/settings.json

+19-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
{
2+
"editor.autoIndent": "advanced",
3+
"editor.insertSpaces": true,
4+
"editor.indentSize": "tabSize",
5+
"editor.tabSize": 2,
6+
7+
"files.insertFinalNewline": true,
8+
"files.trimTrailingWhitespace": true,
9+
210
// https://squidfunk.github.io/mkdocs-material/creating-your-site/
311
"yaml.schemas": {
412
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yaml"
@@ -10,5 +18,15 @@
1018
"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
1119
"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
1220
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
13-
]
21+
],
22+
23+
"[yaml]": {
24+
"editor.defaultFormatter": "redhat.vscode-yaml",
25+
"diffEditor.ignoreTrimWhitespace": false,
26+
"editor.quickSuggestions": {
27+
"other": true,
28+
"comments": false,
29+
"strings": true
30+
}
31+
}
1432
}

‎Contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ use GitHub pull requests for this purpose. Consult
2222
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
2323
information on using pull requests.
2424

25-
See [Developer's Guide](https://github.com/google/android-fhir/wiki/Developer's-Guide) for more information.
25+
See [Contributor's Guide](https://google.github.io/android-fhir/contrib/) for more information.
2626

2727
## Community Guidelines
2828

‎README.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -11,41 +11,43 @@ mobile applications.
1111

1212
The SDK contains the following libraries:
1313

14-
| Library | Latest release | Code | Wiki | Min SDK | Summary |
14+
| Library | Latest release | Code | Docs | Min SDK | Summary |
1515
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
16-
| Data Capture Library | [![Google Maven](https://badgen.net/maven/v/metadata-url/dl.google.com/dl/android/maven2/com/google/android/fhir/data-capture/maven-metadata.xml)](https://maven.google.com/web/index.html?#com.google.android.fhir:data-capture) | [code](https://github.com/google/android-fhir/tree/master/datacapture)| [wiki](https://github.com/google/android-fhir/wiki/Structured-Data-Capture-Library) | Android 7.0 (API level 24) | Collect, validate, and process healthcare data on Android |
17-
| FHIR Engine Library | [![Google Maven](https://badgen.net/maven/v/metadata-url/dl.google.com/dl/android/maven2/com/google/android/fhir/engine/maven-metadata.xml)](https://maven.google.com/web/index.html?#com.google.android.fhir:engine) | [code](https://github.com/google/android-fhir/tree/master/engine) | [wiki](https://github.com/google/android-fhir/wiki/FHIR-Engine-Library) | Android 7.0 (API level 24) | Store and manage FHIR resources locally on Android and synchronize with FHIR server |
18-
| Workflow Library | [![Google Maven](https://badgen.net/maven/v/metadata-url/dl.google.com/dl/android/maven2/com/google/android/fhir/workflow/maven-metadata.xml)](https://maven.google.com/web/index.html?#com.google.android.fhir:workflow) | [code](https://github.com/google/android-fhir/tree/master/workflow) | [wiki](https://github.com/google/android-fhir/wiki/Workflow-Library) | Android 7.0 (API level 24) | Provide decision support and analytics in clinical workflow on Android including implementation of specific FHIR operations ($measure_evaluate and $apply) |
16+
| Data Capture Library | [![Google Maven](https://badgen.net/maven/v/metadata-url/dl.google.com/dl/android/maven2/com/google/android/fhir/data-capture/maven-metadata.xml)](https://maven.google.com/web/index.html?#com.google.android.fhir:data-capture) | [code](https://github.com/google/android-fhir/tree/master/datacapture)| [docs](https://google.github.io/android-fhir/use/SDCL/) | Android 7.0 (API level 24) | Collect, validate, and process healthcare data on Android |
17+
| FHIR Engine Library | [![Google Maven](https://badgen.net/maven/v/metadata-url/dl.google.com/dl/android/maven2/com/google/android/fhir/engine/maven-metadata.xml)](https://maven.google.com/web/index.html?#com.google.android.fhir:engine) | [code](https://github.com/google/android-fhir/tree/master/engine) | [docs](https://google.github.io/android-fhir/use/FEL/) | Android 7.0 (API level 24) | Store and manage FHIR resources locally on Android and synchronize with FHIR server |
18+
| Workflow Library | [![Google Maven](https://badgen.net/maven/v/metadata-url/dl.google.com/dl/android/maven2/com/google/android/fhir/workflow/maven-metadata.xml)](https://maven.google.com/web/index.html?#com.google.android.fhir:workflow) | [code](https://github.com/google/android-fhir/tree/master/workflow) | [docs](https://google.github.io/android-fhir/use/WFL/) | Android 7.0 (API level 24) | Provide decision support and analytics in clinical workflow on Android including implementation of specific FHIR operations ($measure_evaluate and $apply) |
1919

2020
## Demo apps
2121

2222
This repository also contains the following demo apps:
2323

24-
| Demo app | Code | Wiki |
25-
| ----------------------------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- |
26-
| FHIR Engine Demo App | [code](https://github.com/google/android-fhir/tree/master/demo) | [wiki](https://github.com/google/android-fhir/wiki/FHIR-Engine-Library#demo-app) |
27-
| Structured Data Capture Catalog App | [code](https://github.com/google/android-fhir/tree/master/catalog) | [wiki](https://github.com/google/android-fhir/wiki/Structured-Data-Capture-Library#catalog-app) |
24+
| Demo app | Code | Docs |
25+
| ----------------------------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------- |
26+
| FHIR Engine Demo App | [code](https://github.com/google/android-fhir/tree/master/demo) | [docs](https://google.github.io/android-fhir/use/FEL/Demo-app/) |
27+
| Structured Data Capture Catalog App | [code](https://github.com/google/android-fhir/tree/master/catalog) | [docs](https://google.github.io/android-fhir/use/SDCL/Demo-app/) |
2828

2929
**These applications are provided for demo purposes only. Do NOT use in production.**
3030

3131
## Contributing
3232

3333
The development of the SDK began as a collaborative effort between Google, [The World Health Organization](https://www.who.int/), and [Ona](https://ona.io/). Since then, a consortium of application developers have been contributing to the project.
3434

35-
To contribute to the project, please see [Contributing](https://github.com/google/android-fhir/wiki/Contributing) to get started.
35+
To contribute to the project, please see [Contributing](https://google.github.io/android-fhir/contrib/) to get started.
3636

3737
## Feedback and getting help
3838

3939
You can create a [GitHub issue](https://github.com/google/android-fhir/issues) for bugs and feature requests.
4040

4141
In case you find any security bug, please do NOT create a GitHub issue. Instead, email us at <[email protected]>.
4242

43-
If you want to provide any feedback or discuss use cases you can:
43+
If you want to provide any feedback or discuss use cases you can:
44+
4445
* email us at <[email protected]>
4546
* start a [GitHub discussion](https://github.com/google/android-fhir/discussions)
4647
* start a new topic in [android](https://chat.fhir.org/#narrow/stream/276344-android), [questionnaire](https://chat.fhir.org/#narrow/stream/179255-questionnaire), [implementers](https://chat.fhir.org/#narrow/stream/179166-implementers), or [WHO SMART guidelines](https://chat.fhir.org/#narrow/stream/310477-who-smart-guidelines) stream in the [FHIR Zulip chat](https://chat.fhir.org/)
4748

4849
## Disclaimer
50+
4951
This product is not intended to be a medical device.
5052

5153
HL7®, and FHIR® are the registered trademarks of Health Level Seven International and their use of

‎docs/contrib/dependencies.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# External Dependencies
2+
3+
This Android FHIR SDK uses a number of external libraries.
4+
5+
Their exact version numbers are shown on [the Dependency Graph Insights](https://github.com/google/android-fhir/network/dependencies), which is automatically updated.

0 commit comments

Comments
 (0)