[GH-1105] - WIP - Documentation style guide revision (#1196)

* Add ".DS_Store" to gitignore * Added section on merge conflicts * Added files to .gitignore * Created Using RST & MD pages * Edited Doc style guide, added .DS_Store to gitignore * Re-ordered sections in style guide * Edited style guide, added new pages to SUMMARY.md
mattermost · Apr 5, 2023 · 2ca50a3 · 2ca50a3
1 parent 66a133c
commit 2ca50a3
Show file tree

Hide file tree

Showing 8 changed files with 403 additions and 407 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -1 +1,5 @@
 .DS_Store
+.DS_Store
+operations/.DS_Store
+operations/research-and-development/product/.DS_Store
+.DS_Store
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -112,6 +112,8 @@
       * [Technical Writer levels](operations/research-and-development/product/technical-writing-team-handbook/writer-levels.md)
       * [Docathon 2021](operations/research-and-development/product/technical-writing-team-handbook/docathon-2021/README.md)
         * [Getting started with contributing](operations/research-and-development/product/technical-writing-team-handbook/docathon-2021/docathon-processes.md)
+      * [Using Markdown](operations/research-and-development/product/technical-writing-team-handbook/using-markdown.md)
+      * [Using reStructuredText markup](/operations/research-and-development/product/technical-writing-team-handbook/using-restructured-text.md)
     * [Growth](operations/research-and-development/product/growth/README.md)
       * [A/B testing methodology](operations/research-and-development/product/growth/ab-testing.md)
       * [PQL definition](operations/research-and-development/product/growth/pql.md)

diff --git a/operations/.DS_Store b/operations/.DS_Store
diff --git a/operations/research-and-development/product/.DS_Store b/operations/research-and-development/product/.DS_Store
diff --git a/...evelopment/product/technical-writing-team-handbook/documentation-style-guide.md b/...evelopment/product/technical-writing-team-handbook/documentation-style-guide.md
diff --git a/...earch-and-development/product/technical-writing-team-handbook/using-markdown.md b/...earch-and-development/product/technical-writing-team-handbook/using-markdown.md
@@ -0,0 +1,3 @@
+## Using Markdown
+
+The majority of Mattermost technical documentation is written in `.rst` format. However, there are some instances where Markdown is used, for example the Mattermost Handbook. You can read more about using Markdown in the [Formatting Text](https://docs.mattermost.com/messaging/formatting-text.html) section of the Mattermost product documentation.
diff --git a/...-development/product/technical-writing-team-handbook/using-restructured-text.md b/...-development/product/technical-writing-team-handbook/using-restructured-text.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## Using Markdown

		The majority of Mattermost technical documentation is written in `.rst` format. However, there are some instances where Markdown is used, for example the Mattermost Handbook. You can read more about using Markdown in the [Formatting Text](https://docs.mattermost.com/messaging/formatting-text.html) section of the Mattermost product documentation.