Minor docs update for easier maintenance #1116
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
March 3, 2018 11:11
Take the burden off the core team to identify which markdown flavor is experiencing the issue.
|
ps. @styfle has also given really valuable feedback on the docs as they've been coming; so, don't want y'all to think I was saying the criticisms were not warranted nor unwelcome. |
styfle
reviewed
Mar 3, 2018
| @@ -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 --> | |||
There was a problem hiding this comment.
This comment is in the wrong place now. It should be after the Marked Version bold part.
There was a problem hiding this comment.
Updated - added change to initial PR comment.
styfle
approved these changes
Mar 3, 2018
UziTech
approved these changes
Mar 4, 2018
davisjam
pushed a commit
to davisjam/marked
that referenced
this pull request
Mar 4, 2018
* 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_
zhenalexfan
pushed a commit
to zhenalexfan/MarkdownHan
that referenced
this pull request
Nov 8, 2021
* 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_
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Marked version: 0.3.17
Description
This PR:
Adds Markdown flavor to issues and PR templates: This should reduce our overhead in triaging new issues (if the template isn't followed, it's closed). We should also be able to deprecate the
parsercategory of labels (updating the consolidation issues to the new template, if possible).Adds the "Totally Tron" badge to the AUTHORS page: For those who fight for the users (and, just to make sure the base is covered: https://youtu.be/8kcgosLwPDE).
Renames the RELEASE.md to PUBLISHING.md: This keeps our language consistent across the docs compared to AUTHORS.
I'm a contributor - CONTRIBUTING.
A committer - COMMITTING (don't have that yet, maybe @intcreator could help? If you were to be made a committer, what do you think you would need or want to know? The rest of us are all tainted by history; so, you're probably the best person to ask 😃 ).
An Admin - ADMINISTERING (don't have that yet, maybe @styfle and the other committers. Calling @styfle out specifically because he's the resident open source, of course guy, has mentioned the docs might need some work, and so on).
A Publisher - PUBLISHING (instead of RELEASE).
My "position" [noun] matches closely to the documentation for it, which would be better served as a verb, imho. The odd ball is PUBLISHING, because GitHub sets the linguistic standard via CONTRIBUTING being a recognized named file by the application...as opposed to CONTRIBUTE. So, if we went with CONTRIBUTE, GitHub wouldn't recognize it, I don't think...anyway, ELMO-ing myself as pedantic and esoteric.
Renames the USAGE_ to USING_: I'm a user using.
Contributor
Committer
In most cases, this should be a different person than the contributor.