aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar kosayoda <[email protected]>2021-03-24 00:55:28 +0800
committerGravatar kosayoda <[email protected]>2021-03-24 00:55:28 +0800
commitdd16d63b3a6f1f646879c35e09fadfcbe39a03d1 (patch)
tree89648be2735e67da303bbc1b1fb1c0471f5bc780
parentFix content columns when there is no sidebar. (diff)
Rename `short_description` to `description`.
Given that there is no "long description", just `description` conveys the same information with brevity.
-rw-r--r--pydis_site/apps/content/resources/guides/pydis-guides/how-to-write-a-article.md80
-rw-r--r--pydis_site/apps/content/tests/test_content/category/subcategory/test4.md2
-rw-r--r--pydis_site/apps/content/tests/test_content/category/test3.md2
-rw-r--r--pydis_site/apps/content/tests/test_content/test.md2
-rw-r--r--pydis_site/apps/content/tests/test_content/test2.md2
-rw-r--r--pydis_site/templates/content/listing.html2
-rw-r--r--pydis_site/templates/content/page.html2
7 files changed, 6 insertions, 86 deletions
diff --git a/pydis_site/apps/content/resources/guides/pydis-guides/how-to-write-a-article.md b/pydis_site/apps/content/resources/guides/pydis-guides/how-to-write-a-article.md
deleted file mode 100644
index ec89988c..00000000
--- a/pydis_site/apps/content/resources/guides/pydis-guides/how-to-write-a-article.md
+++ /dev/null
@@ -1,80 +0,0 @@
----
-title: How to Write a Article
-short_description: Learn how to write a article for this website
-icon_class: fas
-icon: fa-info
----
-
-When you are interested about how to write articles for this site (like this), then you can learn about it here.
-PyDis use Markdown (GitHub Markdown) files for articles.
-
-## Getting Started
-Before you can get started with writing a article, you need idea.
-Best way to find out is your idea good is to discuss about it in #dev-contrib channel. There can other peoples give their opinion about your idea. Even better, open issue in site repository first, then PyDis staff can see it and approve/decline this idea.
-It's good idea to wait for staff decision before starting to write guide to avoid case when you write a long long article, but then this don't get approved.
-
-To start with contributing, you should read [how to contribute to site](https://pythondiscord.com/pages/contributing/site/).
-You should also read our [Git workflow](https://pythondiscord.com/pages/contributing/working-with-git/), because you need to push your guide to GitHub.
-
-## Creating a File
-All articles is located at `site` repository, in `pydis_site/apps/content/resources/content`. Under this is root level articles (.md files) and categories (directories). Learn more about categories in [categories section](#categories).
-
-When you are writing guides, then these are located under `guides` category.
-
-At this point, you will need your article name for filename. Replace all your article name spaces with `-` and make all lowercase. Save this as `.md` (Markdown) file. This name (without Markdown extension) is path of article in URL.
-
-## Markdown Metadata
-Article files have some required metadata, like title, description, relevant pages. Metadata is first thing in file, YAML-like key-value pairs:
-
-```md
----
-title: My Article
-short_description: This is my short description.
-relevant_links: url1,url2,url3
-relevant_link_values: Text for url1,Text for url2,Text for url3
----
-
-Here comes content of article...
-```
-
-You can read more about Markdown metadata [here](https://github.com/trentm/python-markdown2/wiki/metadata).
-
-### Fields
-- **Name:** Easily-readable name for your article.
-- **Short Description:** Small, 1-2 line description that describe what your article explain.
-- **Relevant Links and Values:** URLs and values is under different fields, separated with comma.
-- **Icon class:** `icon_class` field have one of the favicons classes. Default is `fab`.
-- **Icon:** `icon` field have favicon name. Default `fa-python`.
-
-## Content
-For content, mostly you can use standard markdown, but there is a few addition that is available.
-
-### IDs for quick jumps
-System automatically assign IDs to headers, so like this header will get ID `ids-for-quick-jumps`.
-
-### Tables
-Tables like in GitHub is supported too:
-
-| This is header | This is too header |
-| -------------- | ------------------ |
-| My item | My item too |
-
-### Codeblocks
-Also this system supports codeblocks and provides syntax highlighting with `highlight.js`.
-To activate syntax highlight, just put language directly after starting backticks.
-
-```py
-import os
-
-path = os.path.join("foo", "bar")
-```
-
-## Categories
-To have some systematic sorting of guides, site support guides categories. Currently this system support only 1 level of categories. Categories live at `site` repo in `pydis_site/apps/content/resources/content` subdirectories. Directory name is path of category in URL. Inside category directory, there is 1 file required: `_info.yml`. This file need 2 key-value pairs defined:
-
-```yml
-name: Category name
-description: Category description
-```
-
-Then all Markdown files in this folder will be under this category.
diff --git a/pydis_site/apps/content/tests/test_content/category/subcategory/test4.md b/pydis_site/apps/content/tests/test_content/category/subcategory/test4.md
index 8031131d..1763a869 100644
--- a/pydis_site/apps/content/tests/test_content/category/subcategory/test4.md
+++ b/pydis_site/apps/content/tests/test_content/category/subcategory/test4.md
@@ -1,6 +1,6 @@
---
title: Test 4
-short_description: Testing 4
+description: Testing 4
---
This is also test content and in subcategory.
diff --git a/pydis_site/apps/content/tests/test_content/category/test3.md b/pydis_site/apps/content/tests/test_content/category/test3.md
index 03ddd67b..9f294130 100644
--- a/pydis_site/apps/content/tests/test_content/category/test3.md
+++ b/pydis_site/apps/content/tests/test_content/category/test3.md
@@ -1,6 +1,6 @@
---
title: Test 3
-short_description: Testing 3
+description: Testing 3
---
This is too test content, but in category.
diff --git a/pydis_site/apps/content/tests/test_content/test.md b/pydis_site/apps/content/tests/test_content/test.md
index ca06c1d5..709860d1 100644
--- a/pydis_site/apps/content/tests/test_content/test.md
+++ b/pydis_site/apps/content/tests/test_content/test.md
@@ -1,6 +1,6 @@
---
title: Test
-short_description: Testing
+description: Testing
relevant_links:
Asking Good Questions: https://pythondiscord.com/pages/resources/guides/asking-good-questions/
Help Channel Guide: https://pythondiscord.com/pages/resources/guides/help-channels/
diff --git a/pydis_site/apps/content/tests/test_content/test2.md b/pydis_site/apps/content/tests/test_content/test2.md
index 14d8a54b..0e57c3cd 100644
--- a/pydis_site/apps/content/tests/test_content/test2.md
+++ b/pydis_site/apps/content/tests/test_content/test2.md
@@ -1,6 +1,6 @@
---
title: Test 2
-short_description: Testing 2
+description: Testing 2
---
This is too test content.
diff --git a/pydis_site/templates/content/listing.html b/pydis_site/templates/content/listing.html
index 097cac4f..6c84a38c 100644
--- a/pydis_site/templates/content/listing.html
+++ b/pydis_site/templates/content/listing.html
@@ -50,7 +50,7 @@
<a href="{% url "content:page_category" location=path|add:page %}">
<span class="is-size-4 has-text-weight-bold">{{ data.title }}</span>
</a>
- <p class="is-italic">{{ data.short_description }}</p>
+ <p class="is-italic">{{ data.description }}</p>
</div>
{% endfor %}
</div>
diff --git a/pydis_site/templates/content/page.html b/pydis_site/templates/content/page.html
index a687933d..c3b2285b 100644
--- a/pydis_site/templates/content/page.html
+++ b/pydis_site/templates/content/page.html
@@ -5,7 +5,7 @@
{% block head %}
<meta property="og:title" content="Python Discord - {{ page.metadata.title }}" />
<meta property="og:type" content="website" />
- <meta property="og:description" content="{{ page.metadata.short_description }}" />
+ <meta property="og:description" content="{{ page.metadata.description }}" />
<link rel="stylesheet" href="{% static "css/content/page.css" %}">
<link rel="stylesheet"
href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.1/styles/atom-one-dark-reasonable.min.css">