From ef59812d3399dfec16a43565f2b02dfe5c1b81f6 Mon Sep 17 00:00:00 2001 From: Johannes Christ Date: Mon, 7 Jun 2021 21:21:21 +0200 Subject: 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 8c21b5b0..24227f24 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. --- .../content/resources/guides/pydis-guides/contributing/site.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'pydis_site/apps') 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 8c21b5b0..24227f24 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. -- cgit v1.2.3