aboutsummaryrefslogtreecommitdiffstats
path: root/pydis_site/README.md
diff options
context:
space:
mode:
authorGravatar Johannes Christ <[email protected]>2022-02-26 15:18:55 +0100
committerGravatar Johannes Christ <[email protected]>2022-02-26 15:18:55 +0100
commit69c88813d95e04abe17f6fadab221cce5d5bb619 (patch)
treeb542b64d43828dd95e64a388b3d07a6c4a8ec39c /pydis_site/README.md
parentElaborate on purpose of the urls module (diff)
Elaborate on settings.py
Co-authored-by: Leon Sandøy <[email protected]>
Diffstat (limited to 'pydis_site/README.md')
-rw-r--r--pydis_site/README.md21
1 files changed, 14 insertions, 7 deletions
diff --git a/pydis_site/README.md b/pydis_site/README.md
index b0b6d122..8aa7b1f6 100644
--- a/pydis_site/README.md
+++ b/pydis_site/README.md
@@ -18,9 +18,11 @@ for all logic powering our website. Let's go over the directories in detail:
files relevant for a specific application are put into subdirectories named
after the application.
-- [`templates`](./templates) contains our **[Django templates](https://docs.djangoproject.com/en/dev/topics/templates/)**. Like with static
- files, templates specific to a single application are stored in a subdirectory
- named after that application. We also have two special templates here:
+- [`templates`](./templates) contains our **[Django
+ templates](https://docs.djangoproject.com/en/dev/topics/templates/)**. Like
+ with static files, templates specific to a single application are stored in a
+ subdirectory named after that application. We also have two special templates
+ here:
- `404.html`, which is our error page shown when a site was not found.
@@ -40,11 +42,16 @@ the website:
read more, see the [`RequestContext` documentation from
Django](https://docs.djangoproject.com/en/dev/ref/templates/api/#django.template.RequestContext)
-- [`settings.py`](./settings.py), our Django settings file. This mostly just
- parses configuration out of your environment variables, so you shouldn't need
- to edit it directly unless you want to add new settings.
+- [`settings.py`](./settings.py), our Django settings file. This controls all
+ manner of crucial things, for instance, we use it to configure logging, our
+ connection to the database, which applications are run by the project, which
+ middleware we are using, and variables for `django-simple-bulma` (which
+ determines frontend colours & extensions for our pages).
-- [`urls.py`](./urls.py), the URL configuration for the project itself. Here we can forward certain URL paths to our different apps, which have their own `urls.py` files to configure where their subpaths will lead. These files determine _which URLs will lead to which Django views_.
+- [`urls.py`](./urls.py), the URL configuration for the project itself. Here we
+ can forward certain URL paths to our different apps, which have their own
+ `urls.py` files to configure where their subpaths will lead. These files
+ determine _which URLs will lead to which Django views_.
- [`wsgi.py`](./wsgi.py), which serves as an adapter for
[`gunicorn`](https://github.com/benoitc/gunicorn),