Minor docs update for easier maintenance (#1116)

* Add markdown flavors to issues and pr templates Take the burden off the core team to identify which markdown flavor is experiencing the issue. * Add Totally Tron badge * Rename RELEASE to PUBLISHING * Move comment based on review * Rename USAGE_ to USING_
markedjs · Mar 4, 2018 · ecbf4b0 · ecbf4b0
1 parent 5768180
commit ecbf4b0
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 2 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,5 +1,7 @@
 **Marked version:**
 
+**Markdown flavor:** Markdown.pl|CommonMark|GitHub Flavored Markdown|n/a
+
 <!-- The NPM version or commit hash having the issue --> 
 
 <!-- 

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -14,6 +14,8 @@
 
 <!-- The NPM version or commit hash having the issue -->
 
+**Markdown flavor:** Markdown.pl|CommonMark|GitHub Flavored Markdown|n/a
+
 ## Description
 
 - Fixes #### (if fixing a known issue; otherwise, describe issue using the following format)

diff --git a/AUTHORS.md b/AUTHORS.md
@@ -132,6 +132,8 @@ Badges at play:
 	<dd>Someone who has demonstrated a high degree of expertise or authority when it comes to software security.</dd>
 	<dt>Titan of the Test Harness</dt>
 	<dd>Someone who demonstrates high-levels of understanding regarding Marked's test harness.</dd>
+	<dt>Totally Tron</dt>
+	<dd>Someone who demonstrates they are willing and able to "fight for the users", both developers dependent on marked to do their jobs as well as end-users interacting with the output (particularly in the realm of those with the disabilities).</dd>
 </dl>
 
 Special badges that come with the job:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -90,6 +90,6 @@ To build your own minified version of Marked:
 npm run build
 ```
 
-## Releasing
+## Publishing
 
-Creating GitHub releases and publishing to NPM is limited to conributors and owners. If you would like more information, please see our [releasing documentation](https://github.com/markedjs/marked/blob/master/RELEASE.md).
+Creating GitHub releases and publishing to NPM is limited to conributors and owners. If you would like more information, please see our [publishing documentation](https://github.com/markedjs/marked/blob/master/PUBLISHING.md).
diff --git a/RELEASE.md → PUBLISHING.md b/RELEASE.md → PUBLISHING.md
diff --git a/USAGE_ADVANCED.md → USING_ADVANCED.md b/USAGE_ADVANCED.md → USING_ADVANCED.md
diff --git a/USAGE_EXTENSIBILITY.md → USING_PRO.md b/USAGE_EXTENSIBILITY.md → USING_PRO.md