doc: add Support section in README by Trott · Pull Request #16533 · nodejs/node · GitHub

Add a Support section, borrowing heavily from wp-cli project.

Move stuff about contributing to Node.js to the bottom as vastly more
users are interested in using Node.js and getting help with Node.js than
contributing to Node.js. Information still belongs, just not at the top.
(Many people will know to look in CONTRIBUTING.md anyway.)

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

Ping @danielbachhuber who appears to have authored most of the similar text for wp-cli. Hopefully they can loop in anyone else from that project who might be relevant. Just in case they disagree with my assessment that the amount of borrowed text does not warrant a LICENSE mention or anything like that.

Ref: https://github.com/wp-cli/wp-cli#support

I release my WP-CLI support section contributions to the public domain.

I'm also humbled and honored that you copied my text 😄

Missing/mismatched reference.

@vsemozhetbyt Thanks, fixed!

Missing/mismatched reference.

Missing ( before the href.

prefer named refs ([xx][name])

+1 to "Support" vs. "Resources for Newcomers"

Worth it to ditch the IRC link and just simply say "See CONTRIBUTING.md for details", since that venue is definitely mentioned there?

+1 to @maclover7.
Not that the IRC is too noisy, but RTFMing before asking there will IMHO get the requester better answers.

Just FYI that a few of these links are broken :)

Is it worth to add this in TOC?

Not used reference.

Ditto.

% nits

You can do:

... using a [currently-supported version of Node.js][release-sched].

...

[release-sched]: https://github.com/nodejs/Release#release-schedule

prefer named refs ([xx][name])

+1 to @maclover7.
Not that the IRC is too noisy, but RTFMing before asking there will IMHO get the requester better answers.

LGTM % broken link syntax

Add a Support section, borrowing heavily from wp-cli project. Move stuff about contributing to Node.js to the bottom as vastly more users are interested in using Node.js and getting help with Node.js than contributing to Node.js. Information still belongs, just not at the top. (Many people will know to look in CONTRIBUTING.md anyway.) Refs: https://github.com/wp-cli/wp-cli#support

LGTM

Add a Support section, borrowing heavily from wp-cli project. Move stuff about contributing to Node.js to the bottom as vastly more users are interested in using Node.js and getting help with Node.js than contributing to Node.js. Information still belongs, just not at the top. (Many people will know to look in CONTRIBUTING.md anyway.) PR-URL: nodejs#16533 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

Landed in 6b6474d.

The IRC link is mentioned in CONTRIBUTING.md which is linked immediately above. We should encourage people to read that doc before hoping on the IRC channel. Refs: nodejs#16533 (comment)

@Trott It fails doc linter due to [Node.js Moderation Policy] unused definition in line 595.

Fix: #17108

@Trott It fails doc linter due to [Node.js Moderation Policy] unused definition in line 595.

Hmmm...it passed for me...I thought...ugh, embarrassing. Sorry. Thanks for the fix.

@Trott Could it be that you have run ESLint, but not remark-lint?

@vsemozhetbyt Yes, exactly! I did make lint-js because...that's what I do without thinking.

Well, we have so many linters now, it may really be confusing)

Well, we have so many linters now, it may really be confusing)

True, but I should have run a CI job anyway.

https://github.com/nodejs/node-core-utils can help with this check now)

The IRC link is mentioned in CONTRIBUTING.md which is linked immediately above. We should encourage people to read that doc before hoping on the IRC channel. PR-URL: nodejs#17106 Ref: nodejs#16533 (comment) Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

Add a Support section, borrowing heavily from wp-cli project. Move stuff about contributing to Node.js to the bottom as vastly more users are interested in using Node.js and getting help with Node.js than contributing to Node.js. Information still belongs, just not at the top. (Many people will know to look in CONTRIBUTING.md anyway.) PR-URL: #16533 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

The IRC link is mentioned in CONTRIBUTING.md which is linked immediately above. We should encourage people to read that doc before hoping on the IRC channel. PR-URL: #17106 Ref: #16533 (comment) Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

Add a Support section, borrowing heavily from wp-cli project. Move stuff about contributing to Node.js to the bottom as vastly more users are interested in using Node.js and getting help with Node.js than contributing to Node.js. Information still belongs, just not at the top. (Many people will know to look in CONTRIBUTING.md anyway.) PR-URL: #16533 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

The IRC link is mentioned in CONTRIBUTING.md which is linked immediately above. We should encourage people to read that doc before hoping on the IRC channel. PR-URL: #17106 Ref: #16533 (comment) Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

Add a Support section, borrowing heavily from wp-cli project. Move stuff about contributing to Node.js to the bottom as vastly more users are interested in using Node.js and getting help with Node.js than contributing to Node.js. Information still belongs, just not at the top. (Many people will know to look in CONTRIBUTING.md anyway.) PR-URL: #16533 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

The IRC link is mentioned in CONTRIBUTING.md which is linked immediately above. We should encourage people to read that doc before hoping on the IRC channel. PR-URL: #17106 Ref: #16533 (comment) Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

Trott added the doc Issues and PRs related to the documentations. label Oct 26, 2017

Trott force-pushed the update-readme branch from 197a07d to 975f233 Compare October 26, 2017 23:20

vsemozhetbyt reviewed Oct 26, 2017

View reviewed changes

maclover7 reviewed Oct 26, 2017

View reviewed changes

vsemozhetbyt reviewed Oct 26, 2017

View reviewed changes

vsemozhetbyt approved these changes Oct 26, 2017

View reviewed changes

refack approved these changes Oct 26, 2017

View reviewed changes

gireeshpunathil approved these changes Oct 27, 2017

View reviewed changes

Fishrock123 approved these changes Oct 27, 2017

View reviewed changes

joyeecheung approved these changes Oct 28, 2017

View reviewed changes

Trott force-pushed the update-readme branch 4 times, most recently from 42733ee to 6fa1fbf Compare November 12, 2017 00:59

Trott force-pushed the update-readme branch from 6fa1fbf to ea7ec94 Compare November 12, 2017 01:01

jasnell approved these changes Nov 12, 2017

View reviewed changes

mhdawson approved these changes Nov 16, 2017

View reviewed changes

Trott closed this Nov 17, 2017

Trott mentioned this pull request Nov 17, 2017

doc: multiple README fixes #17106

Closed

3 tasks

vsemozhetbyt mentioned this pull request Nov 17, 2017

doc: fix a link in dgram.md #17107

Closed

3 tasks

MylesBorins mentioned this pull request Dec 12, 2017

v9.3.0 proposal #17631

Merged

MylesBorins added the land-on-v6.x label Dec 19, 2017

gibfahn added the land-on-v8.x label Dec 19, 2017

gibfahn mentioned this pull request Dec 20, 2017

v8.9.4 proposal #17772

Closed

gibfahn mentioned this pull request Dec 20, 2017

v8.9.4 proposal #17774

Merged

MylesBorins mentioned this pull request Dec 20, 2017

v6.12.3 proposal #17776

Merged

Trott deleted the update-readme branch January 13, 2022 22:47

doc: add Support section in README by Trott · Pull Request #16533 · nodejs/node · GitHub

Uh oh!

Uh oh!

doc: add Support section in README - #16533

doc: add Support section in README#16533Trott wants to merge 1 commit intonodejs:masternodejs/node:masterfrom Trott:update-readmeTrott/io.js:update-readmeCopy head branch name to clipboard

Conversation

Trott commented Oct 26, 2017

Checklist

Affected core subsystem(s)

Uh oh!

Trott commented Oct 26, 2017

Uh oh!

danielbachhuber commented Oct 26, 2017

Uh oh!

danielbachhuber commented Oct 26, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maclover7 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

refack left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joyeecheung left a comment

Choose a reason for hiding this comment

Uh oh!

mhdawson left a comment

Choose a reason for hiding this comment

Uh oh!

Trott commented Nov 17, 2017

Uh oh!

vsemozhetbyt commented Nov 17, 2017

Uh oh!

vsemozhetbyt commented Nov 17, 2017

Uh oh!

Trott commented Nov 17, 2017

Uh oh!

vsemozhetbyt commented Nov 17, 2017

Uh oh!

Trott commented Nov 17, 2017

Uh oh!

vsemozhetbyt commented Nov 17, 2017

Uh oh!

Trott commented Nov 18, 2017

Uh oh!

vsemozhetbyt commented Nov 18, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

doc: add Support section in README#16533
Trott wants to merge 1 commit into
nodejs:masterfrom
Trott:update-readme