aboutsummaryrefslogtreecommitdiffstats
path: root/pydis_site/apps/content/README.md
blob: e7061207373891b17019d7bf55f9ae330e010eb8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 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.


## Contributing pages

The Markdown files hosting our content can be found in the
[`resources/`](./resources) directory. The process of contributing to 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/).
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/)

- `tests` contains unit tests for verifying that the app works properly.

- `views` contains Django views which generate and serve 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.