doc: update style guide for markdown extension #15786
Closed
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
vsemozhetbyt
approved these changes
Oct 5, 2017
lance
approved these changes
Oct 5, 2017
gibfahn
approved these changes
Oct 6, 2017
richardlau
reviewed
Oct 6, 2017
doc/STYLE_GUIDE.md
Outdated
| @@ -6,8 +6,7 @@ | |||
| topic the document will describe (e.g., `child_process`). | |||
| * Filenames should be **lowercase**. | |||
| * Some files, such as top-level markdown files, are exceptions. | |||
| * Older files may use the `.markdown` extension. These may be ported to `.md` | |||
| at will. **Prefer `.md` for all new documents.** | |||
| * Use `.md` as the file extension for markdown files. | |||
There was a problem hiding this comment.
Is this necessary given the extension is included in the example in the parent bullet (lowercase-with-dashes.md)?
There was a problem hiding this comment.
Or maybe merge with the existing bullet about filenames should be lowercase above.
There was a problem hiding this comment.
I'm happy to remove it entirely. It seems unlikely that we will have a rampant problem with people using the wrong file extension for new docs.
There are no longer files in the repository that use the `.markdown` extension so remove mention of them.
richardlau
approved these changes
Oct 6, 2017
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Oct 8, 2017
There are no longer files in the repository that use the `.markdown` extension so remove mention of them. PR-URL: nodejs#15786 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Lance Ball <lball@redhat.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
|
Landed in e012229 |
MylesBorins
pushed a commit
that referenced
this pull request
Oct 11, 2017
There are no longer files in the repository that use the `.markdown` extension so remove mention of them. PR-URL: #15786 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Lance Ball <lball@redhat.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Merged
addaleax
pushed a commit
to addaleax/ayo
that referenced
this pull request
Oct 12, 2017
There are no longer files in the repository that use the `.markdown` extension so remove mention of them. PR-URL: nodejs/node#15786 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Lance Ball <lball@redhat.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
MylesBorins
pushed a commit
that referenced
this pull request
Oct 17, 2017
There are no longer files in the repository that use the `.markdown` extension so remove mention of them. PR-URL: #15786 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Lance Ball <lball@redhat.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
|
landed on v6.x assuming it is relevant to that branch lmk if I am wrong |
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Oct 18, 2017
There are no longer files in the repository that use the `.markdown` extension so remove mention of them. PR-URL: #15786 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Lance Ball <lball@redhat.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
MylesBorins
pushed a commit
that referenced
this pull request
Oct 25, 2017
There are no longer files in the repository that use the `.markdown` extension so remove mention of them. PR-URL: #15786 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Lance Ball <lball@redhat.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Merged
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.
There are no longer files in the repository that use the
.markdownextension so remove mention of them.
Checklist
Affected core subsystem(s)
doc