From 42b153a3e7676a9b93ef268cdee1924a3c362e8c Mon Sep 17 00:00:00 2001 From: Johannes Christ Date: Thu, 6 Apr 2023 10:35:36 +0200 Subject: Add README for the redirects app (#924) This is kept more minimal than the other apps, as it's mostly for backwards compatibility. --- pydis_site/apps/redirect/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 pydis_site/apps/redirect/README.md (limited to 'pydis_site/apps') 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)! -- cgit v1.2.3