diff --git a/README.md b/README.md index a6e8e58c..7f678fea 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,10 @@ $ docker-compose -f docker-compose-with-celery.yml down [Generate a new personal access token](https://github.com/settings/tokens) and replace the value for `GITHUB_TOKEN` in your `.env` file in order to connect to certain parts of the GitHub API. +### `ENVIRONMENT_NAME` + +Optional. Set a name for local development that will display in a banner in the Django Admin. + ## Running the tests To run the tests, execute: @@ -96,6 +100,11 @@ For production, execute: $ yarn build ``` +## Local Dev - Markdown content handling + +1. Clone the content repo to your local machine, at the same level as this repo: https://github.com/boostorg/website2022. Docker-compose will look for this folder and its contents on your machine, so it can copy the contents into a Docker container. + + ## Deploying TDB diff --git a/docker-compose.yml b/docker-compose.yml index 0142042b..aa2d47be 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -39,6 +39,7 @@ services: - "8000:8000" volumes: - .:/code + - ../website2022/:/website stop_signal: SIGKILL networks: