Skip to content

Commit dded29c

Browse files
authored
Fix links to docker-compose.yml (#233)
## Ticket n/a ## Changes - #227 moved the docker-compose.yml file out of the root and into /app, but missed updating links to it in the documentation. This updates those links. ## Context for reviewers n/a ## Testing n/a
1 parent ebe2640 commit dded29c

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/app/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ direnv: export +API_AUTH_TOKEN +AWS_ACCESS_KEY_ID +AWS_DEFAULT_REGION +AWS_SECRE
9696

9797
Most configuration options are managed by environment variables.
9898

99-
Environment variables for local development are stored in the [local.env](/app/local.env) file. This file is automatically loaded when running. If running within Docker, this file is specified as an `env_file` in the [docker-compose](/docker-compose.yml) file, and loaded [by a script](/app/src/util/local.py) automatically when running unit tests (see running natively above for other cases).
99+
Environment variables for local development are stored in the [local.env](/app/local.env) file. This file is automatically loaded when running. If running within Docker, this file is specified as an `env_file` in the [docker-compose](/app/docker-compose.yml) file, and loaded [by a script](/app/src/util/local.py) automatically when running unit tests (see running natively above for other cases).
100100

101-
Any environment variables specified directly in the [docker-compose](/docker-compose.yml) file will take precedent over those specified in the [local.env](/app/local.env) file.
101+
Any environment variables specified directly in the [docker-compose](/app/docker-compose.yml) file will take precedent over those specified in the [local.env](/app/local.env) file.
102102

103103
## Authentication
104104

docs/app/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This application is dockerized. Take a look at [Dockerfile](/app/Dockerfile) to see how it works.
44

5-
A very simple [docker-compose.yml](/docker-compose.yml) has been included to support local development and deployment. Take a look at [docker-compose.yml](/docker-compose.yml) for more information.
5+
A very simple [docker-compose.yml](/app/docker-compose.yml) has been included to support local development and deployment. Take a look at [docker-compose.yml](/app/docker-compose.yml) for more information.
66

77
## Prerequisites
88

0 commit comments

Comments
 (0)