summaryrefslogtreecommitdiffstats
path: root/doc/process/documentation-guidelines.md
diff options
context:
space:
mode:
authorlindy65 <lindy@spinpunch.com>2015-11-12 20:35:05 +0200
committerlindy65 <lindy@spinpunch.com>2015-11-12 20:35:05 +0200
commit10a8e968fe0bc6f61e747e0cd66ce4fbd9d9bb15 (patch)
treebcca79e97675e667f684c7707b9b2c04e87fadee /doc/process/documentation-guidelines.md
parent931f4f764cbd18f1f5189e03ece83685e4dc6ffa (diff)
downloadchat-10a8e968fe0bc6f61e747e0cd66ce4fbd9d9bb15.tar.gz
chat-10a8e968fe0bc6f61e747e0cd66ce4fbd9d9bb15.tar.bz2
chat-10a8e968fe0bc6f61e747e0cd66ce4fbd9d9bb15.zip
Update documentation-guidelines.md
Fixed typo on line 44 and added "Sub-section Headings..."
Diffstat (limited to 'doc/process/documentation-guidelines.md')
-rw-r--r--doc/process/documentation-guidelines.md21
1 files changed, 19 insertions, 2 deletions
diff --git a/doc/process/documentation-guidelines.md b/doc/process/documentation-guidelines.md
index f186da6bd..e75bb3169 100644
--- a/doc/process/documentation-guidelines.md
+++ b/doc/process/documentation-guidelines.md
@@ -41,7 +41,7 @@ This procedure works on Linux servers running Python 2.6 and higher.
### Use headings
-Headings in markdown provide anchors that can be used to easily reference sub-sections of long pieces of documentation. This is preferrable to just numbering sections without headings.
+Headings in markdown provide anchors that can be used to easily reference sub-sections of long pieces of documentation. This is preferable to just numbering sections without headings.
##### Correct:
@@ -77,7 +77,24 @@ H3, H4, H5 headings should be "Sentence case" and can be any length.
These headers are smaller and used to summarize sections. H3 can be considered either a large or small heading.
-These conventions are new, so there's flexibility around them, when you're not sure, consider the convention here as default.
+These conventions are new, so there's flexibility around them, when you're not sure, consider the convention here as default.
+
+### Sub-section headings should end with a colon
+
+For readability and clear layout, end a sub-section heading with a colon
+
+##### Correct:
+
+----
+Service Based:
+- [AWS Elastic Beanstalk Setup](https://github.com/mattermost/platform/blob/master/doc/install/Amazon-Elastic-Beanstalk.md)
+----
+##### Incorrect:
+
+----
+Optional
+- [Community Guide for Production Debian Setup](https://github.com/mattermost/platform/blob/master/doc/install/Production-Debian.md)
+----
### One instruction per line