Commit Graph

166 Commits

Author SHA1 Message Date
Jonathan Darling
0cd1f54fab doc: standardizing on make -j4
Standardizes docs to use -j4 instead of -j8 as it appears to be the
most inclusive recommendation based on discussion in
https://github.com/nodejs/node/pull/9961.

PR-URL: https://github.com/nodejs/node/pull/9961
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
2016-12-09 15:53:20 -05:00
Safia Abdalla
947baaf5b7 doc: rename writing_tests.md to writing-tests.md
The writing_tests.md file did not utilize kebab-case as the other files
in the directory did.

PR-URL: https://github.com/nodejs/node/pull/9867
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
2016-12-03 10:45:27 +01:00
Ali Ijaz Sheikh
11b087222b doc: add guide for maintaining V8
Ref: https://github.com/nodejs/LTS/pull/137
PR-URL: https://github.com/nodejs/node/pull/9777
Reviewed-By: mhdawson - Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: targos - Michaël Zasso <mic.besace@gmail.com>
2016-11-28 16:17:43 -08:00
Jeremiah Senkpiel
4affb8929f doc: clarify the exit code part of writing_tests
PR-URL: https://github.com/nodejs/node/pull/9502
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2016-11-11 10:23:00 -05:00
timathon
843770406b
doc: fix link to Event Loop page
PR-URL: https://github.com/nodejs/node/pull/9527
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2016-11-11 16:10:38 +01:00
Gibson Fahnestock
3e6cc607b0 doc: note that tests should include a description
Update the Writing Tests guide to specify that tests should include a
brief description of what they are designed to test.

PR-URL: https://github.com/nodejs/node/pull/9415

Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>oc
2016-11-05 13:01:21 +00:00
Yangyang Liu
bf46f223e7
doc: fix outdate ninja link
PR-URL: https://github.com/nodejs/node/pull/9278
Reviewed-By: Roman Reiss <me@silverwind.io>
2016-11-01 23:53:52 +01:00
Niklas Ingholt
3326081bd4 doc: recommend using port 0 instead of common.PORT
In the 'writing_tests' guide it is recommended to use common.PORT
instead of an arbitrary value, but the recommendation is to use
port 0 instead and the docs should reflect that.

PR-URL: https://github.com/nodejs/node/pull/8694
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2016-10-04 01:05:44 +03:00
Сковорода Никита Андреевич
bedc6b6247 doc: enable no-file-name-articles remark-lint rule
This renames doc/topics/the-event-loop-timers-and-nexttick.md to
doc/topics/event-loop-timers-and-nexttick.md, which looks like a
better name for that file and enables no-file-name-articles remark-lint
rule to prevent such names in the future.

PR-URL: https://github.com/nodejs/node/pull/8713
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-09-27 07:07:40 -07:00
Сковорода Никита Андреевич
50be885285 tools: enable more remark-lint rules
New rules:
 1. rule-style
 2. strong-marker
 3. no-shell-dollars
 4. no-inline-padding
 5. code-block-style
 6. no-multiple-toplevel-headings

Fixes to the existing files applied.

PR-URL: https://github.com/nodejs/node/pull/8708
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-09-25 13:02:45 +03:00
Alexis374
5930d59b0f
doc: fix a wrong link,add '.md' to the link
fix a wrong link to ../topics/the-event-loop-timers-and-nexttick.md

PR-URL: https://github.com/nodejs/node/pull/8315
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-09-02 23:53:07 +02:00
Сковорода Никита Андреевич
a58b48bc3b doc: various documentation formatting fixes
* Fix markdown code sample in releases.md, it was <a id="x.y.x></a>"
* Fix some markdown errors, e.g. in changelogs
* Fix broken defs links, e.g. in domain-postmortem.md
* Fix other broken refs, by addaleax
* Add links to some defs that were present but not linked to
* Remove dead defs
* Move defs to the bottom (one file affected)
* Add language indicators to all code blocks, using `txt` when no
specific language could be chosen
* Some minor formatting changes (spaces, ident, headings)

PR-URL: https://github.com/nodejs/node/pull/7637
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
2016-07-14 12:26:50 +03:00
Ryan Lewis
1299c2764e doc: add guide for Node.js Timers
Refs: https://github.com/nodejs/docs/issues/76
PR-URL: https://github.com/nodejs/node/pull/6825
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2016-07-01 18:57:27 +02:00
Santiago Gimeno
b83b363839 doc,test: add How to write a Node.js test guide
PR-URL: https://github.com/nodejs/node/pull/6984
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com>
2016-05-30 10:24:10 +02:00
Ehsan Akhgari
de5020292e build: re-add --ninja option to configure
Ninja is a build backend supported by gyp which is much faster than
Make and is able to parallelize builds across all of the available
cores very well. On my machine, this reduces the average build time
from 5:14 minutes to 4:33 minutes.

Refs: https://github.com/nodejs/node/pull/467
Refs: de224d6e6c
PR-URL: https://github.com/nodejs/node/pull/6780
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2016-05-27 18:13:41 -04:00
Jeremiah Senkpiel
65c0feb5fe doc: add "building node with ninja" guide
PR-URL: https://github.com/nodejs/node/pull/4767
Refs: https://github.com/nodejs/docs/pull/38
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Stephan Belanger <admin@stephenbelanger.com>
2016-02-23 12:23:45 -05:00