File tree Expand file tree Collapse file tree 1 file changed +37
-0
lines changed Expand file tree Collapse file tree 1 file changed +37
-0
lines changed Original file line number Diff line number Diff line change
1
+ # The "content" app
2
+
3
+ This application serves static, markdown-based content. Django-wise there is
4
+ relatively little code in there, most of it is concerned with serving our
5
+ content.
6
+
7
+ The markdown files hosting our content can be found in the
8
+ [ ` resources/ ` ] ( ./resources ) directory, and contain
9
+
10
+
11
+ ## Contributing pages
12
+
13
+ Contributing pages is covered extensively in our online guide, which you can
14
+ find
15
+ [ here] ( https://www.pythondiscord.com/pages/guides/pydis-guides/how-to-contribute-a-page/ )
16
+ or alternatively read it directly at
17
+ [ ` resources/guides/pydis-guides/how-to-contribute-a-page.md ` ] ( ./resources/guides/pydis-guides/how-to-contribute-a-page.md ) .
18
+
19
+
20
+ ## Directory structure
21
+
22
+ Let's look at the structure in here:
23
+
24
+ - ` resources ` contains the static Markdown files that make up our site's
25
+ [ pages] ( https://www.pythondiscord.com/pages/ )
26
+
27
+ - ` migrations ` contains standard Django migrations. As the ` content ` app
28
+ contains purely static markdown files, no migrations are present here.
29
+
30
+ - ` tests ` contains unit tests for verifying that the app works properly.
31
+
32
+ - ` views ` contains our Django views generating and serving the pages from the
33
+ input markdown.
34
+
35
+ As for the modules, apart from the standard Django modules in here, the
36
+ ` utils.py ` module contains utility functions for discovering markdown files to
37
+ serve on the filesystem.
You can’t perform that action at this time.
0 commit comments