Skip to content

Commit

Permalink
Fix links to docker-compose.yml (#233)
Browse files Browse the repository at this point in the history
## 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
  • Loading branch information
KevinJBoyer committed Jul 5, 2024
1 parent ebe2640 commit dded29c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ direnv: export +API_AUTH_TOKEN +AWS_ACCESS_KEY_ID +AWS_DEFAULT_REGION +AWS_SECRE

Most configuration options are managed by environment variables.

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).
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).

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.
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.

## Authentication

Expand Down
2 changes: 1 addition & 1 deletion docs/app/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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.
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.

## Prerequisites

Expand Down

0 comments on commit dded29c

Please sign in to comment.