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.

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

doc: make node(1) more consistent with tradition #8902

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
7 participants
@strugee
Contributor

strugee commented Oct 3, 2016

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change
  • Removed loads of whitespace
  • Added traditional BUGS and AUTHORS sections
  • Renamed ENVIRONMENT VARIABLES to ENVIRONMENT, as is traditional

In particular I'm not sure if everyone will be cool with the BUGS text - I personally think it's good but if anyone disagrees I'm not super attached to it. Also, I put .\"s instead of outright removing the newlines because I think it's (slightly) more readable, but I can also get rid of those.

@bnoordhuis

This comment has been minimized.

Show comment
Hide comment
@bnoordhuis

bnoordhuis Oct 3, 2016

Member

The "has many bugs" in the BUGS section is too nondescript to be useful, I'd change it to a REPORTING BUGS section with a link to the bug tracker.

I personally don't care for an AUTHORS section; it's not very relevant to readers and in our case it's misleading because Ryan hasn't worked on node for something like four years now.

Suggestion: a LICENSE section might be a good addition.

Member

bnoordhuis commented Oct 3, 2016

The "has many bugs" in the BUGS section is too nondescript to be useful, I'd change it to a REPORTING BUGS section with a link to the bug tracker.

I personally don't care for an AUTHORS section; it's not very relevant to readers and in our case it's misleading because Ryan hasn't worked on node for something like four years now.

Suggestion: a LICENSE section might be a good addition.

Show outdated Hide outdated doc/node.1
@Fishrock123

This comment has been minimized.

Show comment
Hide comment
@Fishrock123

Fishrock123 Oct 3, 2016

Member

I don't agree with the ./" -- imo this will only make it harder for people less familiar to contribute to this. I suggest removing those.

Member

Fishrock123 commented Oct 3, 2016

I don't agree with the ./" -- imo this will only make it harder for people less familiar to contribute to this. I suggest removing those.

Show outdated Hide outdated doc/node.1
Show outdated Hide outdated doc/node.1
@strugee

This comment has been minimized.

Show comment
Hide comment
@strugee

strugee Oct 3, 2016

Contributor

@bnoordhuis @Fishrock123 changed the wording of the BUGS section to be more concise. If people still disagree with this I can just remove it entirely

I also changed AUTHORS to not mention Ryan, got rid of the .\"s and added a COPYRIGHT section

Contributor

strugee commented Oct 3, 2016

@bnoordhuis @Fishrock123 changed the wording of the BUGS section to be more concise. If people still disagree with this I can just remove it entirely

I also changed AUTHORS to not mention Ryan, got rid of the .\"s and added a COPYRIGHT section

Show outdated Hide outdated doc/node.1
Show outdated Hide outdated doc/node.1
Show outdated Hide outdated doc/node.1
Show outdated Hide outdated doc/node.1
@strugee

This comment has been minimized.

Show comment
Hide comment
@strugee

strugee Oct 4, 2016

Contributor

All issues fixed, including the "All rights reserved" section (even though it's inconsistent with LICENSE).

Contributor

strugee commented Oct 4, 2016

All issues fixed, including the "All rights reserved" section (even though it's inconsistent with LICENSE).

@jasnell

jasnell approved these changes Oct 6, 2016

Couple of nits I'd like to see fixed up but otherwise LGTM

Show outdated Hide outdated doc/node.1
@@ -219,5 +231,5 @@ Mailing list:
IRC (general questions):
.ur "chat.freenode.net #node.js"

This comment has been minimized.

@jasnell

jasnell Oct 6, 2016

Member

Nit: Given that #node.js is not yet considered an official resource managed by the project, a note indicating it's unofficial status might be worthwhile.

@jasnell

jasnell Oct 6, 2016

Member

Nit: Given that #node.js is not yet considered an official resource managed by the project, a note indicating it's unofficial status might be worthwhile.

Show outdated Hide outdated doc/node.1
@strugee

This comment has been minimized.

Show comment
Hide comment
@strugee

strugee Oct 6, 2016

Contributor

👍 all issues fixed; this is ready to merge

Contributor

strugee commented Oct 6, 2016

👍 all issues fixed; this is ready to merge

Show outdated Hide outdated doc/node.1
doc: make node(1) more consistent with tradition
* Added traditional BUGS, AUTHORS and COPYRIGHT sections
* Fixed some minor issues with the IRC links

jasnell added a commit that referenced this pull request Oct 8, 2016

doc: make node(1) more consistent with tradition
* Added traditional BUGS, AUTHORS and COPYRIGHT sections
* Fixed some minor issues with the IRC links

PR-URL: #8902
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnell

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell Oct 8, 2016

Member

Landed in 90cd39f. Thank you!

Member

jasnell commented Oct 8, 2016

Landed in 90cd39f. Thank you!

@jasnell jasnell closed this Oct 8, 2016

@strugee

This comment has been minimized.

Show comment
Hide comment
@strugee

strugee Oct 8, 2016

Contributor

Thanks very much! 👍

Contributor

strugee commented Oct 8, 2016

Thanks very much! 👍

jasnell added a commit that referenced this pull request Oct 10, 2016

doc: make node(1) more consistent with tradition
* Added traditional BUGS, AUTHORS and COPYRIGHT sections
* Fixed some minor issues with the IRC links

PR-URL: #8902
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

Fishrock123 added a commit that referenced this pull request Oct 11, 2016

doc: make node(1) more consistent with tradition
* Added traditional BUGS, AUTHORS and COPYRIGHT sections
* Fixed some minor issues with the IRC links

PR-URL: #8902
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

MylesBorins added a commit that referenced this pull request Nov 22, 2016

doc: make node(1) more consistent with tradition
* Added traditional BUGS, AUTHORS and COPYRIGHT sections
* Fixed some minor issues with the IRC links

PR-URL: #8902
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

@MylesBorins MylesBorins referenced this pull request Nov 22, 2016

Merged

v4.7.0 proposal #9736

@strugee strugee deleted the strugee:better-manpage branch Aug 26, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment