doc: minor doc improvements #17722

BridgeAR · 2017-12-17T23:56:44Z

Seems like some parts of the docs are currently actually not linted? Otherwise these files would probably result in a couple of errors. I went ahead and fixed things as I think is best. This does not mean they will already work with our lint rules and they might need further work but I think it is a good step into the right direction.

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)

doc

maclover7

In general, LGTM, although I'm a little concerned about the amount of git churn here. People obviously don't bisect the docs as much as actual code, but still useful to have a good history to refer back to.

maclover7 · 2017-12-18T00:55:10Z

doc/guides/building-node-with-ninja.md

+1. Run `ninja -C out/Release` to produce a compiled release binary.
+1. Lastly, make symlink to `./node` using `ln -fs out/Release/node node`.
+
+When running `ninja -C out/Release` you will see output similar to the following


While we're here, can you add a comma after ninja -C out/Release

I would rather keep this PR only about stylistic changes.

BridgeAR · 2017-12-19T02:34:52Z

I rebase tomorrow

CI https://ci.nodejs.org/job/node-test-commit-light/40/

richardlau · 2017-12-19T04:58:11Z

doc/guides/backporting-to-release-lines.md

-2. Make sure that the local staging branch is up to date with the remote
-3. Create a new branch off of the staging branch
+1. Make sure that the local staging branch is up to date with the remote
+1. Create a new branch off of the staging branch


I prefer the numbering of the steps before this change (i.e. When it didn't reset to 1 after the examples).

Ok, I checked and most files use 1. 2. 3... even though there is at least one file that uses 1. 1. 1.... I personally prefer the latter as it allows to reorder things easily / removing a single entry without creating any churn.

My point is that this change has renumbered the steps so that instead of steps 1-10 it now reads steps 1-3, 1, 1-6.

You are right. I did not check that anymore. I just removed the commit as our style currently does not really rely on it. I guess it might be introduced as a general thing or it should not be used further at all.

BridgeAR · 2017-12-20T21:12:04Z

Rebased and I removed a commit about changing the numbers.

BridgeAR · 2017-12-20T21:13:49Z

CI https://ci.nodejs.org/job/node-test-commit-light/44/

richardlau · 2017-12-21T01:28:28Z

Commit message nit: asterixs->asterisks

This will also use a proper indentation as a couple of entries had a extra indentation of two spaces.

BridgeAR · 2017-12-21T21:41:37Z

Rebased

BridgeAR · 2017-12-21T21:42:23Z

New CI https://ci.nodejs.org/job/node-test-commit-light/51/

BridgeAR · 2017-12-26T09:42:07Z

Landed in 9ca4ab1, 6924dac, 5c29013

This will also use a proper indentation as a couple of entries had a extra indentation of two spaces. PR-URL: nodejs#17722 Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>

PR-URL: nodejs#17722 Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>

This will also use a proper indentation as a couple of entries had a extra indentation of two spaces. PR-URL: #17722 Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>

PR-URL: #17722 Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>

This will also use a proper indentation as a couple of entries had a extra indentation of two spaces. PR-URL: #17722 Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>

PR-URL: #17722 Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>

This will also use a proper indentation as a couple of entries had a extra indentation of two spaces. PR-URL: #17722 Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>

PR-URL: #17722 Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>

gibfahn · 2018-01-24T02:23:20Z

Landed the first commit on 6.x and 8.x (the others conflicted).

PR-URL: #17722 Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]>

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Dec 17, 2017

maclover7 approved these changes Dec 18, 2017

View reviewed changes

lpinca approved these changes Dec 18, 2017

View reviewed changes

jasnell approved these changes Dec 18, 2017

View reviewed changes

richardlau reviewed Dec 19, 2017

View reviewed changes

danbev approved these changes Dec 19, 2017

View reviewed changes

BridgeAR force-pushed the doc-updates branch from d29f5f3 to a009267 Compare December 20, 2017 21:10

BridgeAR added 3 commits December 21, 2017 19:40

doc: update doc formatting to fit our 80 chars rule.

06b0326

This will also use a proper indentation as a couple of entries had a extra indentation of two spaces.

doc: use consistent new lines

f6810ac

doc: use dashes instead of asterisks

eef95c3

BridgeAR force-pushed the doc-updates branch from a009267 to eef95c3 Compare December 21, 2017 21:41

BridgeAR closed this Dec 26, 2017

MylesBorins mentioned this pull request Jan 10, 2018

v9.4.0 proposal #18069

Merged

gibfahn added land-on-v6.x labels Jan 24, 2018

MylesBorins mentioned this pull request Jan 24, 2018

v6.13.0 proposal #18342

Merged

MylesBorins added backported-to-v6.x and removed land-on-v6.x labels Feb 27, 2018

BridgeAR deleted the doc-updates branch April 1, 2019 23:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: minor doc improvements #17722

doc: minor doc improvements #17722

BridgeAR commented Dec 17, 2017

maclover7 left a comment

maclover7 Dec 18, 2017

BridgeAR Dec 18, 2017

BridgeAR commented Dec 19, 2017

richardlau Dec 19, 2017 •

edited

Loading

BridgeAR Dec 20, 2017

richardlau Dec 20, 2017

BridgeAR Dec 20, 2017

BridgeAR commented Dec 20, 2017

BridgeAR commented Dec 20, 2017

richardlau commented Dec 21, 2017

BridgeAR commented Dec 21, 2017

BridgeAR commented Dec 21, 2017

BridgeAR commented Dec 26, 2017

gibfahn commented Jan 24, 2018

doc: minor doc improvements #17722

doc: minor doc improvements #17722

Conversation

BridgeAR commented Dec 17, 2017

Checklist

Affected core subsystem(s)

maclover7 left a comment

Choose a reason for hiding this comment

maclover7 Dec 18, 2017

Choose a reason for hiding this comment

BridgeAR Dec 18, 2017

Choose a reason for hiding this comment

BridgeAR commented Dec 19, 2017

richardlau Dec 19, 2017 • edited Loading

Choose a reason for hiding this comment

BridgeAR Dec 20, 2017

Choose a reason for hiding this comment

richardlau Dec 20, 2017

Choose a reason for hiding this comment

BridgeAR Dec 20, 2017

Choose a reason for hiding this comment

BridgeAR commented Dec 20, 2017

BridgeAR commented Dec 20, 2017

richardlau commented Dec 21, 2017

BridgeAR commented Dec 21, 2017

BridgeAR commented Dec 21, 2017

BridgeAR commented Dec 26, 2017

gibfahn commented Jan 24, 2018

richardlau Dec 19, 2017 •

edited

Loading