aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Johannes Christ <[email protected]>2023-04-06 10:35:36 +0200
committerGravatar GitHub <[email protected]>2023-04-06 08:35:36 +0000
commit42b153a3e7676a9b93ef268cdee1924a3c362e8c (patch)
tree4ed0d65e689f0a3ea0448749c38329ca9ae354b7
parentMerge pull request #927 from python-discord/dependabot/pip/psycopg2-binary-2.9.6 (diff)
Add README for the redirects app (#924)
This is kept more minimal than the other apps, as it's mostly for backwards compatibility.
-rw-r--r--pydis_site/apps/redirect/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/pydis_site/apps/redirect/README.md b/pydis_site/apps/redirect/README.md
new file mode 100644
index 00000000..0d3c1e33
--- /dev/null
+++ b/pydis_site/apps/redirect/README.md
@@ -0,0 +1,13 @@
+# The "redirect" app
+
+This Django application manages redirects on our website. The main magic
+happens in `urls.py`, which transforms our redirects as configured in
+`redirects.yaml` into Django URL routing rules. `tests.py` on the other hand
+simply checks that all redirects configured in `redirects.yaml` work as
+expected.
+
+As suggested by the comment in `redirects.yaml`, this app is mainly here for
+backwards compatibility for our old dewikification project. It is unlikely you
+need to edit it directly. If you did find a reason to perform changes here,
+please [open an
+issue](https://github.com/python-discord/site/issues/new/choose)!