Skip to content

Commit ef59812

Browse files
committed
Address review comments.
- Link detail section in environment variables section. - Update old static path from pre-Docker environment times and mention the Docker setup. diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md index 8c21b5b..24227f2 100644 --- a/pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md +++ b/pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md @@ -79,6 +79,9 @@ SECRET_KEY=suitable-for-development-only STATIC_ROOT=staticfiles ``` +The [Configuration in Detail](#configuration-in-detail) section contains +detailed information about these settings. + #### Notes regarding `DATABASE_URL` - If the database is hosted locally i.e. on the same machine as the webserver, then use `localhost` for the host. Windows and macOS users may need to use the [Docker host IP](../hosts-file/#windows) instead. @@ -173,5 +176,6 @@ The website is configured through the following environment variables: - **`SECRET_KEY`**: The secret key used in various parts of Django. Keep this secret as the name suggests! This is managed for you in debug setups. -- **`STATIC_ROOT`**: The root in which `python manage.py collectstatic` collects - static files. Optional, defaults to `/var/www/pythondiscord.com`. +- **`STATIC_ROOT`**: The root in which `python manage.py collectstatic` + collects static files. Optional, defaults to `/app/staticfiles` for the + standard Docker deployment.
1 parent 172f839 commit ef59812

File tree

1 file changed

+6
-2
lines changed
  • pydis_site/apps/content/resources/guides/pydis-guides/contributing

1 file changed

+6
-2
lines changed

pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ SECRET_KEY=suitable-for-development-only
7979
STATIC_ROOT=staticfiles
8080
```
8181

82+
The [Configuration in Detail](#configuration-in-detail) section contains
83+
detailed information about these settings.
84+
8285
#### Notes regarding `DATABASE_URL`
8386

8487
- If the database is hosted locally i.e. on the same machine as the webserver, then use `localhost` for the host. Windows and macOS users may need to use the [Docker host IP](../hosts-file/#windows) instead.
@@ -173,5 +176,6 @@ The website is configured through the following environment variables:
173176
- **`SECRET_KEY`**: The secret key used in various parts of Django. Keep this
174177
secret as the name suggests! This is managed for you in debug setups.
175178

176-
- **`STATIC_ROOT`**: The root in which `python manage.py collectstatic` collects
177-
static files. Optional, defaults to `/var/www/pythondiscord.com`.
179+
- **`STATIC_ROOT`**: The root in which `python manage.py collectstatic`
180+
collects static files. Optional, defaults to `/app/staticfiles` for the
181+
standard Docker deployment.

0 commit comments

Comments
 (0)