From c0666e5095c6e427b786fb934520d63fabaa8840 Mon Sep 17 00:00:00 2001 From: Johannes Christ Date: Sat, 12 Mar 2022 16:41:11 +0100 Subject: Add a README for the content directory --- pydis_site/apps/content/README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 pydis_site/apps/content/README.md (limited to 'pydis_site/apps') 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. -- cgit v1.2.3 From ca2c583b15d46d7821a03ec047678429f96c7e03 Mon Sep 17 00:00:00 2001 From: Johannes Christ Date: Sat, 12 Mar 2022 21:51:28 +0100 Subject: Reword documentation per review Co-authored-by: MarkKoz --- pydis_site/apps/content/README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) (limited to 'pydis_site/apps') diff --git a/pydis_site/apps/content/README.md b/pydis_site/apps/content/README.md index b2719a9f..d36d6bee 100644 --- a/pydis_site/apps/content/README.md +++ b/pydis_site/apps/content/README.md @@ -1,19 +1,17 @@ # 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 +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 +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). @@ -25,13 +23,13 @@ Let's look at the structure in here: [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. + 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. +- `views` contains Django views which generating 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 on the filesystem. +`utils.py` module contains utility functions for discovering Markdown files to +serve. -- cgit v1.2.3 From 4ad92b98a0df047b12e302ce8d849c2bd85862f1 Mon Sep 17 00:00:00 2001 From: Johannes Christ Date: Sat, 12 Mar 2022 21:53:53 +0100 Subject: Remove unused migrations package --- pydis_site/apps/content/README.md | 3 --- pydis_site/apps/content/migrations/__init__.py | 0 2 files changed, 3 deletions(-) delete mode 100644 pydis_site/apps/content/migrations/__init__.py (limited to 'pydis_site/apps') diff --git a/pydis_site/apps/content/README.md b/pydis_site/apps/content/README.md index d36d6bee..4149a6f0 100644 --- a/pydis_site/apps/content/README.md +++ b/pydis_site/apps/content/README.md @@ -22,9 +22,6 @@ 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 Django views which generating and serve the pages from the diff --git a/pydis_site/apps/content/migrations/__init__.py b/pydis_site/apps/content/migrations/__init__.py deleted file mode 100644 index e69de29b..00000000 -- cgit v1.2.3 From 2bf88327c6298e9004aeda028576946b1704d799 Mon Sep 17 00:00:00 2001 From: Johannes Christ Date: Sat, 12 Mar 2022 22:43:52 +0100 Subject: Correct typo Co-authored-by: Mark <1515135+MarkKoz@users.noreply.github.com> --- pydis_site/apps/content/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'pydis_site/apps') diff --git a/pydis_site/apps/content/README.md b/pydis_site/apps/content/README.md index 4149a6f0..e7061207 100644 --- a/pydis_site/apps/content/README.md +++ b/pydis_site/apps/content/README.md @@ -24,7 +24,7 @@ Let's look at the structure in here: - `tests` contains unit tests for verifying that the app works properly. -- `views` contains Django views which generating and serve the pages from the +- `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 -- cgit v1.2.3