-
-
Notifications
You must be signed in to change notification settings - Fork 127
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Move config docs to contributing guide, kill docs
directory.
#523
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we have a link mentioning this new details section from the 2. Environment variables
section?
pydis_site/apps/content/resources/guides/pydis-guides/contributing/site.md
Outdated
Show resolved
Hide resolved
- 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.
I've added a link to the section from "Environment variables" and updated the static path. |
Might it be worth mentioning that with Docker, certain environment variables aren't necessary and handled for you? (and list those) |
Yes, I agree. However, isn't this already documented that way? The environment variable section is a subsection "Without Docker", and mentions that additional steps are needed there. |
I forgot it was under "Without Docker", my bad. |
Continuation of #521.