Skip to content

Commit 4f74e8c

Browse files
authored
Updates FHIR Data Pipes setup tutorial documentation (#1516)
1 parent 32426ea commit 4f74e8c

File tree

4 files changed

+16
-12
lines changed

4 files changed

+16
-12
lines changed

doc/docs/tutorials/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
In this section you can access tutorials to learn about different aspects of
44
working with FHIR Data Pipes.
55

6+
- **[Set up local test servers:](test_servers)** Set up local HAPI FHIR server
7+
and load it with synthetic data
68
- **[Single Machine Deployment:](single_machine)** Great for getting started
79
quickly and evaluating FHIR Data Pipes
810
- **[Visualize Parquet DWH with Apache Superset:](add_dashboard)** With the
911
Pipelines set-up, learn how to visualize the data using Apache Superset
10-
- **[Set up local test servers:](test_servers)** Set up local HAPI FHIR server
11-
and load it with synthetic data

doc/docs/tutorials/single_machine.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To learn how the Pipelines Controller works on its own, try out the
1414
- A source [HAPI FHIR server](https://hapifhir.io/) configured to
1515
[use Postgres as its database](https://github.com/hapifhir/hapi-fhir-jpaserver-starter#postgresql-configuration)
1616
- If you don't have a server, use a
17-
[local test server](https://github.com/google/fhir-data-pipes/wiki/Try-the-pipelines-using-local-test-servers)
17+
[local test server](https://google.github.io/fhir-data-pipes/tutorials/test_servers/)
1818
by following the instructions to bring up a source HAPI FHIR server with
1919
Postgres
2020
- [Docker](https://www.docker.com/)
@@ -80,7 +80,7 @@ For documentation of all config parameters, see
8080
[here](https://github.com/google/fhir-data-pipes/blob/master/pipelines/controller/config/application.yaml).
8181

8282
**Note:** If you are using the
83-
[local test servers](https://github.com/google/fhir-data-pipes/wiki/Try-the-pipelines-using-local-test-servers),
83+
[local test servers](https://google.github.io/fhir-data-pipes/tutorials/test_servers/),
8484
things should work with the default values. If not, use the IP address of the
8585
Docker default bridge network. To find it, run the following command and use the
8686
"Gateway" value:

doc/docs/tutorials/test_servers.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ There are _3 Docker server_ configurations you can use for testing:
1414

1515
**Note**: All commands are run from the root directory of the repository.
1616

17+
!!! info "Information" This tutorial has been updated to use `docker compose`
18+
instead of `docker-compose`. If you have an older version of Docker that does
19+
not support `docker compose`, you can continue to use `docker-compose` commands.
20+
1721
1. Create an external Docker network named `cloudbuild`:
1822

1923
```
@@ -84,7 +88,7 @@ There are _3 Docker server_ configurations you can use for testing:
8488
[HAPI FHIR server](https://github.com/google/fhir-data-pipes/blob/master/docker/sink-compose.yml):
8589
8690
```shell
87-
docker-compose -f ./docker/sink-compose.yml up --force-recreate -d
91+
docker compose -f ./docker/sink-compose.yml up --force-recreate -d
8892
```
8993
9094
The base URL for this server is `http://localhost:8098/fhir`.
@@ -96,17 +100,17 @@ username "admin" and password "Admin123". The Docker image includes the required
96100
FHIR2 module and demo data. Edit `docker/openmrs-compose.yaml` to change the
97101
default port.
98102
99-
**Note:** If `docker-compose` fails, you may need to adjust file permissions. In
103+
**Note:** If `docker compose` fails, you may need to adjust file permissions. In
100104
particular if the permissions on `mysqld.cnf` is not right, the `datadir` set in
101105
this file will not be read by MySQL and it will cause OpenMRS to require its
102106
`initialsetup` (which is not needed since the MySQL image already has all the
103107
data and tables needed):
104108
105109
```shell
106-
$ docker-compose -f docker/openmrs-compose.yaml down -v
110+
$ docker compose -f docker/openmrs-compose.yaml down -v
107111
$ chmod a+r docker/mysql-build/mysqld.cnf
108112
$ chmod -R a+r ./utils
109-
$ docker-compose -f docker/openmrs-compose.yaml up
113+
$ docker compose -f docker/openmrs-compose.yaml up
110114
```
111115

112116
In order to see the demo data in OpenMRS you must rebuild the search index. In

doc/mkdocs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ nav:
5656
- 'Deploy the "Controller Module"' : 'installation_controller.md'
5757
- 'Deploy the "Pipelines"' : 'installation_pipeline.md'
5858
- Tutorials:
59-
- tutorials/index.md
60-
- Set up local test servers : tutorials/test_servers.md
61-
- Single Machine Deployment: tutorials/single_machine.md
62-
- Visualize Parquet DWH with Apache Superset: tutorials/add_dashboard.md
59+
- Content : tutorials/index.md
60+
- Step 1 - Set up local test servers(Data) : tutorials/test_servers.md
61+
- Step 2 - Single Machine Deployment(Pipeline): tutorials/single_machine.md
62+
- Step 3 - Visualize Parquet DWH with Apache Superset: tutorials/add_dashboard.md
6363
- Additional Topics: 'additional.md'
6464
- Community:
6565
- 'Support' : 'support.md'

0 commit comments

Comments
 (0)