Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

prepare for markdown linting for prohibited strings #17163

Closed
wants to merge 3 commits into from
Closed

prepare for markdown linting for prohibited strings #17163

wants to merge 3 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Nov 20, 2017

I'm about to open a pull request to add linting for v8 (which should be V8) and Javascript (which should be JavaScript) in our markdown files. If and when that gets added to remark-preset-lint-node, these changes will be necessary. We want to do the text changes regardless, though, so this can land now (if approved and current linting passes, of course).

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@Trott
doc: add capitalization styling to STYLE_GUIDE
b5d947b 
This is mostly an excuse to remind people that it's "V8" and not "v8"
when referring to the JavaScript engine.
@Trott
doc: prepare for v8/V8 linting in doc text
044e423
@Trott
doc: use "JavaScript" instead of "Javascript"
e00defb
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 20, 2017
@Trott Trott mentioned this pull request Nov 20, 2017
Merged
@Trott
Copy link
Member Author

Trott commented Nov 20, 2017

CI: https://ci.nodejs.org/job/node-test-pull-request/11564/

@vsemozhetbyt
Copy link
Contributor

Is it worth to add Node -> Node.js?
And maybe Github (github) -> GitHub.

@Trott
Copy link
Member Author

Trott commented Nov 20, 2017

Is it worth to add Node -> Node.js?
And maybe Github (github) -> GitHub.

@vsemozhetbyt The right/wrong strings are configurable, so we should be able to do that.

@jasnell
Copy link
Member

jasnell commented Nov 20, 2017

ooo, good idea. Linting for you, your, etc would also be good :-)

jasnell pushed a commit that referenced this pull request Nov 22, 2017
@Trott @jasnell
doc: add capitalization styling to STYLE_GUIDE
e577d7d 
This is mostly an excuse to remind people that it's "V8" and not "v8"
when referring to the JavaScript engine.

PR-URL: #17163
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
jasnell pushed a commit that referenced this pull request Nov 22, 2017
@Trott @jasnell
doc: prepare for v8/V8 linting in doc text
911f163 
PR-URL: #17163
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
jasnell pushed a commit that referenced this pull request Nov 22, 2017
@Trott @jasnell
doc: use "JavaScript" instead of "Javascript"
8f2c366 
PR-URL: #17163
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@jasnell
Copy link
Member

jasnell commented Nov 22, 2017

Landed in e577d7d, 911f163, and 8f2c366

@jasnell jasnell closed this Nov 22, 2017
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
@Trott @MylesBorins
doc: add capitalization styling to STYLE_GUIDE
52ea2cb 
This is mostly an excuse to remind people that it's "V8" and not "v8"
when referring to the JavaScript engine.

PR-URL: #17163
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
@Trott @MylesBorins
doc: prepare for v8/V8 linting in doc text
ac16880 
PR-URL: #17163
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
@Trott @MylesBorins
doc: use "JavaScript" instead of "Javascript"
96ba11b 
PR-URL: #17163
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
@Trott @MylesBorins
doc: add capitalization styling to STYLE_GUIDE
bd1dbce 
This is mostly an excuse to remind people that it's "V8" and not "v8"
when referring to the JavaScript engine.

PR-URL: #17163
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
@Trott @MylesBorins
doc: prepare for v8/V8 linting in doc text
9dcf748 
PR-URL: #17163
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
@Trott @MylesBorins
doc: use "JavaScript" instead of "Javascript"
2fccf84 
PR-URL: #17163
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@MylesBorins MylesBorins mentioned this pull request Dec 12, 2017
Merged
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
@Trott @gibfahn
doc: add capitalization styling to STYLE_GUIDE
fcb8b91 
This is mostly an excuse to remind people that it's "V8" and not "v8"
when referring to the JavaScript engine.

PR-URL: #17163
Backport-PR-URL: #17765
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
@Trott @gibfahn
doc: prepare for v8/V8 linting in doc text
d23df03 
PR-URL: #17163
Backport-PR-URL: #17765
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
@Trott @gibfahn
doc: use "JavaScript" instead of "Javascript"
f34ae26 
PR-URL: #17163
Backport-PR-URL: #17765
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@gibfahn gibfahn mentioned this pull request Dec 20, 2017
Closed
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
@Trott @gibfahn
doc: add capitalization styling to STYLE_GUIDE
16dc7a8 
This is mostly an excuse to remind people that it's "V8" and not "v8"
when referring to the JavaScript engine.

PR-URL: #17163
Backport-PR-URL: #17765
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
@Trott @gibfahn
doc: prepare for v8/V8 linting in doc text
5bb5899 
PR-URL: #17163
Backport-PR-URL: #17765
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
@Trott @gibfahn
doc: use "JavaScript" instead of "Javascript"
e68f86b 
PR-URL: #17163
Backport-PR-URL: #17765
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@gibfahn gibfahn mentioned this pull request Dec 20, 2017
Merged
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
@Trott @gibfahn
doc: add capitalization styling to STYLE_GUIDE
772ad87 
This is mostly an excuse to remind people that it's "V8" and not "v8"
when referring to the JavaScript engine.

PR-URL: #17163
Backport-PR-URL: #17765
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
@Trott @gibfahn
doc: prepare for v8/V8 linting in doc text
81afb5c 
PR-URL: #17163
Backport-PR-URL: #17765
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
gibfahn pushed a commit that referenced this pull request Dec 20, 2017
@Trott @gibfahn
doc: use "JavaScript" instead of "Javascript"
5076cf3 
PR-URL: #17163
Backport-PR-URL: #17765
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
gabrielschulhof pushed a commit to gabrielschulhof/node that referenced this pull request Apr 16, 2018
@Trott
doc: use "JavaScript" instead of "Javascript"
32dd8f1 
PR-URL: nodejs#17163
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
MylesBorins pushed a commit that referenced this pull request Apr 16, 2018
@Trott @MylesBorins
doc: use "JavaScript" instead of "Javascript"
c685212 
Backport-PR-URL: #19447
PR-URL: #17163
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
@MylesBorins MylesBorins mentioned this pull request Apr 16, 2018
Merged
@Trott Trott deleted the v8-remark-lint-wip branch January 13, 2022 22:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@benjamingr benjamingr benjamingr approved these changes

@targos targos targos approved these changes

@cjihrig cjihrig cjihrig approved these changes

@aqrln aqrln aqrln approved these changes

@gireeshpunathil gireeshpunathil gireeshpunathil approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet