diff options
Diffstat (limited to 'pydis_site/apps/content')
-rw-r--r-- | pydis_site/apps/content/README.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/pydis_site/apps/content/README.md b/pydis_site/apps/content/README.md new file mode 100644 index 00000000..b2719a9f --- /dev/null +++ b/pydis_site/apps/content/README.md @@ -0,0 +1,37 @@ +# The "content" app + +This application serves static, markdown-based content. Django-wise there is +relatively little code in there, most of it is concerned with serving our +content. + +The markdown files hosting our content can be found in the +[`resources/`](./resources) directory, and contain + + +## Contributing pages + +Contributing pages is covered extensively in our online guide, which you can +find +[here](https://www.pythondiscord.com/pages/guides/pydis-guides/how-to-contribute-a-page/) +or alternatively read it directly at +[`resources/guides/pydis-guides/how-to-contribute-a-page.md`](./resources/guides/pydis-guides/how-to-contribute-a-page.md). + + +## Directory structure + +Let's look at the structure in here: + +- `resources` contains the static Markdown files that make up our site's + [pages](https://www.pythondiscord.com/pages/) + +- `migrations` contains standard Django migrations. As the `content` app + contains purely static markdown files, no migrations are present here. + +- `tests` contains unit tests for verifying that the app works properly. + +- `views` contains our Django views generating and serving the pages from the + input markdown. + +As for the modules, apart from the standard Django modules in here, the +`utils.py` module contains utility functions for discovering markdown files to +serve on the filesystem. |