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

Missing/mismatched reference.

@vsemozhetbyt Thanks, fixed!

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

README.md

Missing/mismatched reference.

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

README.md

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

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

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

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

README.md

Is it worth to add this in TOC?

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

README.md

Not used reference.

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

README.md

Not used reference.

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

README.md

refack

% nits

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

README.md

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

prefer named refs ([xx][name])

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

README.md

+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 <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

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 <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

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 <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

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 <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

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 <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

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 <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

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 <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

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 <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Michael Dawson <[email protected]>

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