Skip to content

Commit 6bcd1fb

Browse files
authored
Merge pull request #56 from jupyterhealth/howto-documentation
docs: add comprehensive Diataxis how-to guides for JupyterHealth Exchange
2 parents 75e1f0e + 1b434c6 commit 6bcd1fb

11 files changed

+7931
-16
lines changed

howto/admins-deployers/add-data-source-type.md

Lines changed: 835 additions & 0 deletions
Large diffs are not rendered by default.

howto/admins-deployers/configuring-hipaa-storage.md

Lines changed: 910 additions & 0 deletions
Large diffs are not rendered by default.

howto/admins-deployers/connecting-new-wearable-api.md

Lines changed: 518 additions & 0 deletions
Large diffs are not rendered by default.

howto/admins-deployers/troubleshooting-ingestion-errors.md

Lines changed: 792 additions & 0 deletions
Large diffs are not rendered by default.

howto/admins-deployers/upgrading-jupyterhealth.md

Lines changed: 776 additions & 0 deletions
Large diffs are not rendered by default.

howto/index.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,22 @@
1-
# How-To guides
1+
# How-To Guides
22

3-
here we should have [how-to guides](https://diataxis.fr/how-to-guides/) for specific operations.
3+
Here we have [how-to guides](https://diataxis.fr/how-to-guides/) for specific operations.
44

55
> How-to guides are directions that guide the reader through a problem or towards a result. How-to guides are goal-oriented.
66
77
Note: [the difference between how-to and tutorial](https://diataxis.fr/tutorials-how-to/)
88

9-
How-to documents we plan to have:
9+
## For JupyterHealth Exchange Admins and Deployment
1010

11-
For JupyterHealth Exchange deployers/admins:
11+
- [Configuring JupyterHealth for HIPAA-Compliant Storage](admins-deployers/configuring-hipaa-storage.md)
12+
- [Add a Data Source, Data Type to the Exchange](admins-deployers/add-data-source-type.md)
13+
- [Connecting JupyterHealth to a New Wearable API](admins-deployers/connecting-new-wearable-api.md)
14+
- [Upgrading JupyterHealth](admins-deployers/upgrading-jupyterhealth.md)
15+
- [Troubleshooting Common Ingestion Errors](admins-deployers/troubleshooting-ingestion-errors.md)
1216

13-
- Configuring JupyterHealth for HIPAA-compliant storage
14-
- Connecting JupyterHealth to a new wearable API
15-
- Troubleshooting common ingestion errors
16-
- Upgrading JupyterHealth
17-
- Add a data source, data type to the Exchange
17+
## For Clinicians and Researchers
1818

19-
For practitioners:
20-
21-
- Using the JupyterHealth REST API
22-
- create a study
23-
- add a patient
24-
- fetch data from the exchange
19+
- [Study Management](practitioners/study-management.md)
20+
- [Patient Management](practitioners/patient-management.md)
21+
- [Fetching and Exporting Data](practitioners/fetching-exporting-data.md)
22+
- [Using the JupyterHealth REST API](practitioners/using-rest-api.md)

0 commit comments

Comments
 (0)