doc: add Support section in README #16533

Trott · 2017-10-26T23:18:03Z

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)

Trott · 2017-10-26T23:19:16Z

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

danielbachhuber · 2017-10-26T23:25:35Z

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

danielbachhuber · 2017-10-26T23:26:38Z

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

vsemozhetbyt · 2017-10-26T23:26:51Z

README.md

-* IRC (node core development): [#node-dev on chat.freenode.net][]
+When looking for support, please first search for your question in these venues:
+
+* [Node.js Website][]


Missing/mismatched reference.

@vsemozhetbyt Thanks, fixed!

vsemozhetbyt · 2017-10-26T23:27:05Z

README.md

+When looking for support, please first search for your question in these venues:
+
+* [Node.js Website][]
+* [Node.js Help repository issues][]


Missing/mismatched reference.

vsemozhetbyt · 2017-10-26T23:27:37Z

README.md

+* [Node.js Website][]
+* [Node.js Help repository issues][]
+* [Open or closed issues in the Node.js GitHub organization](https://github.com/issues?utf8=%E2%9C%93&q=sort%3Aupdated-desc+org%3Anodejs+is%3Aissue)
+* [Questions tagged 'node.js' in StackOverflow]https://stackoverflow.com/questions/tagged/node.js)


Missing ( before the href.

prefer named refs ([xx][name])

maclover7

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

maclover7 · 2017-10-26T23:26:09Z

README.md

+### Contributing to Node.js
+
+* [Contributing to the project][]
+* IRC (node core development): [#node-dev on chat.freenode.net][]


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.

maclover7 · 2017-10-26T23:26:34Z

README.md

-* IRC (node core development): [#node-dev on chat.freenode.net][]
+When looking for support, please first search for your question in these venues:
+
+* [Node.js Website][]


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

vsemozhetbyt · 2017-10-26T23:33:09Z

README.md

@@ -577,11 +578,16 @@ Previous releases may also have been signed with one of the following GPG keys:
 Information on the current Node.js Working Groups can be found in the
 [TSC repository](https://github.com/nodejs/TSC/blob/master/WORKING_GROUPS.md).

+### Contributing to Node.js


Is it worth to add this in TOC?

vsemozhetbyt · 2017-10-26T23:35:41Z

README.md

+
+* [Contributing to the project][]
+* IRC (node core development): [#node-dev on chat.freenode.net][]
+
 [npm]: https://www.npmjs.com
 [Website]: https://nodejs.org/en/


Not used reference.

vsemozhetbyt · 2017-10-26T23:36:23Z

README.md

+
+* [Contributing to the project][]
+* IRC (node core development): [#node-dev on chat.freenode.net][]
+
 [npm]: https://www.npmjs.com
 [Website]: https://nodejs.org/en/
 [Contributing to the project]: CONTRIBUTING.md
 [Node.js Help]: https://github.com/nodejs/help


Not used reference.

vsemozhetbyt · 2017-10-26T23:36:51Z

README.md

+
+* [Contributing to the project][]
+* IRC (node core development): [#node-dev on chat.freenode.net][]
+
 [npm]: https://www.npmjs.com
 [Website]: https://nodejs.org/en/
 [Contributing to the project]: CONTRIBUTING.md
 [Node.js Help]: https://github.com/nodejs/help
 [Node.js Moderation Policy]: https://github.com/nodejs/TSC/blob/master/Moderation-Policy.md


refack

% nits

refack · 2017-10-26T23:46:22Z

README.md

-### Official Resources
+Node.js contributors have limited availability to address general support
+questions. Please make sure you are using a [currently-supported version of
+Node.js](https://github.com/nodejs/Release#release-schedule).


You can do:

... using a [currently-supported version of Node.js][release-sched]. ... [release-sched]: https://github.com/nodejs/Release#release-schedule

refack · 2017-10-26T23:47:45Z

README.md

+* [Node.js Website][]
+* [Node.js Help repository issues][]
+* [Open or closed issues in the Node.js GitHub organization](https://github.com/issues?utf8=%E2%9C%93&q=sort%3Aupdated-desc+org%3Anodejs+is%3Aissue)
+* [Questions tagged 'node.js' in StackOverflow]https://stackoverflow.com/questions/tagged/node.js)


prefer named refs ([xx][name])

refack · 2017-10-26T23:49:49Z

README.md

+### Contributing to Node.js
+
+* [Contributing to the project][]
+* IRC (node core development): [#node-dev on chat.freenode.net][]


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

joyeecheung

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

mhdawson

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>

Trott · 2017-11-17T21:56:21Z

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)

vsemozhetbyt · 2017-11-17T22:28:12Z

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

vsemozhetbyt · 2017-11-17T22:43:37Z

Fix: #17108

Trott · 2017-11-17T23:09:30Z

@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.

vsemozhetbyt · 2017-11-17T23:32:02Z

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

Trott · 2017-11-17T23:40:24Z

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

vsemozhetbyt · 2017-11-17T23:44:19Z

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

Trott · 2017-11-18T00:29:00Z

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

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

vsemozhetbyt · 2017-11-18T00:41:56Z

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: add Support section in README #16533

doc: add Support section in README #16533

Trott commented Oct 26, 2017

Trott commented Oct 26, 2017

danielbachhuber commented Oct 26, 2017

danielbachhuber commented Oct 26, 2017

vsemozhetbyt Oct 26, 2017

Trott Nov 12, 2017

vsemozhetbyt Oct 26, 2017

vsemozhetbyt Oct 26, 2017

refack Oct 26, 2017

maclover7 left a comment

maclover7 Oct 26, 2017

refack Oct 26, 2017

maclover7 Oct 26, 2017

vsemozhetbyt Oct 26, 2017

vsemozhetbyt Oct 26, 2017

vsemozhetbyt Oct 26, 2017

vsemozhetbyt Oct 26, 2017

refack left a comment

refack Oct 26, 2017

refack Oct 26, 2017

refack Oct 26, 2017

joyeecheung left a comment

mhdawson left a comment

Trott commented Nov 17, 2017

vsemozhetbyt commented Nov 17, 2017

vsemozhetbyt commented Nov 17, 2017

Trott commented Nov 17, 2017

vsemozhetbyt commented Nov 17, 2017

Trott commented Nov 17, 2017

vsemozhetbyt commented Nov 17, 2017

Trott commented Nov 18, 2017

vsemozhetbyt commented Nov 18, 2017

doc: add Support section in README #16533

doc: add Support section in README #16533

Conversation

Trott commented Oct 26, 2017

Checklist

Affected core subsystem(s)

Trott commented Oct 26, 2017

danielbachhuber commented Oct 26, 2017

danielbachhuber commented Oct 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maclover7 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

refack left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joyeecheung left a comment

Choose a reason for hiding this comment

mhdawson left a comment

Choose a reason for hiding this comment

Trott commented Nov 17, 2017

vsemozhetbyt commented Nov 17, 2017

vsemozhetbyt commented Nov 17, 2017

Trott commented Nov 17, 2017

vsemozhetbyt commented Nov 17, 2017

Trott commented Nov 17, 2017

vsemozhetbyt commented Nov 17, 2017

Trott commented Nov 18, 2017

vsemozhetbyt commented Nov 18, 2017