Rich Trott
f1b3ade948
doc: add missing period
...
PR-URL: https://github.com/nodejs/node/pull/49094
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: Moshe Atlow <moshe@atlow.co.il >
2023-08-10 15:37:10 +00:00
Rafael Gonzaga
03553c5570
doc: move policy docs to the permissions scope
...
PR-URL: https://github.com/nodejs/node/pull/44222
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
2022-09-05 16:07:45 +00:00
Antoine du Hamel
6afd3fcf65
doc: add node: prefix for all core modules
...
Some core modules can be loaded with or without the `node:` prefix.
Using the prefix disambiguates which specifiers refer to core modules.
This commit updates the docs to use the prefix everywhere a core module
is referenced.
PR-URL: https://github.com/nodejs/node/pull/42752
Fixes: https://github.com/nodejs/node/issues/38343
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Mestery <mestery@protonmail.com >
Reviewed-By: Darshan Sen <raisinten@gmail.com >
Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com >
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com >
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com >
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com >
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com >
2022-04-20 10:23:41 +02:00
Rich Trott
0991dfcece
doc: add blank line between comments
...
Upcoming remark-based formatting/linting will add a blank line between
comments in markdown. This is in preparation for that change.
PR-URL: https://github.com/nodejs/node/pull/40160
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2021-09-21 18:40:04 -07:00
90e2e78763
policy: canonicalize before resolving specifiers
...
PR-URL: https://github.com/nodejs/node/pull/37863
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com >
Co-authored-by: James M Snell <jasnell@gmail.com >
Reviewed-By: Guy Bedford <guybedford@gmail.com >
2021-08-19 12:43:21 -05:00
Rich Trott
163030eded
doc: revise dependency redirection text in policy.md
...
PR-URL: https://github.com/nodejs/node/pull/35276
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2020-09-24 04:30:35 -07:00
Rich Trott
47f4080db4
doc: make general copy-edit changes to policy.md
...
PR-URL: https://github.com/nodejs/node/pull/34943
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
2020-08-29 06:53:00 -07:00
Bradley Farias
4234904232
policy: implement scopes field
...
PR-URL: https://github.com/nodejs/node/pull/34552
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-08-26 14:35:34 -05:00
Bradley Farias
e155d96014
policy: support conditions for redirects
...
PR-URL: https://github.com/nodejs/node/pull/34414
Reviewed-By: Jan Krems <jan.krems@gmail.com >
Reviewed-By: Guy Bedford <guybedford@gmail.com >
2020-08-13 13:17:40 -05:00
Rich Trott
d1d412b413
doc: use sentence-case for headings in docs
...
PR-URL: https://github.com/nodejs/node/pull/33889
Refs: https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings
Refs: https://docs.microsoft.com/en-us/style-guide/capitalization
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-06-19 08:09:05 -07:00
Derek Lewis
549812a9a0
doc: normalize Bash code block info strings
...
Prior to this commit, Bash fenced code blocks in Markdown files had
inconsistent info strings. This has been corrected to standardize on
the less-obscure variant.
PR-URL: https://github.com/nodejs/node/pull/33510
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
2020-05-25 19:08:45 +02:00
Rich Trott
73f2dbc911
doc: remove personal pronoun usage in policy.md
...
Per our style guide, avoid personal pronouns (I, you, we, etc.) in
reference documentation.
PR-URL: https://github.com/nodejs/node/pull/32142
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2020-03-09 19:47:29 -07:00
Rich Trott
10040500da
doc: remove dashes
...
The use of dashes -- in general, but especially in our docs -- can be
problematic. It is used inconsistently and there is always another form
of punctuation that is as good or better for the situation. In an effort
to reduce the number of variations we use to display the same types of
information, remove the various uses of dashes from the documentation.
PR-URL: https://github.com/nodejs/node/pull/30101
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2019-10-26 08:39:41 -07:00
Nick Schonning
9a46cfc337
doc: remove multiple consecutive blank lines
...
These are rendered as single breaks.
Addresses Markdownlint MD012 rule.
PR-URL: https://github.com/nodejs/node/pull/29352
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2019-08-31 15:27:58 -07:00
Bradley Farias
7e8ad9bad8
policy: add dependencies map for resources
...
Adds a "dependencies" field to resources in policy manifest files.
In order to ease development and testing while using manifests,
wildcard values for both "dependencies" and "integrity" have been
added using the boolean value "true" in the policy manifest.
PR-URL: https://github.com/nodejs/node/pull/28767
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Jan Krems <jan.krems@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2019-07-26 15:13:53 -05:00
Bradley Farias
6c288a7044
policy: add policy-integrity to mitigate policy tampering
...
PR-URL: https://github.com/nodejs/node/pull/28734
Reviewed-By: Gus Caplan <me@gus.host >
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
Reviewed-By: Guy Bedford <guybedford@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2019-07-20 13:24:58 -07:00
Richard Lau
bbb2134e7b
doc: fix metadata for v11.8.0 doc changes
...
Refs: https://github.com/nodejs/node/commit/641de82404d5fa381053e0f5abd522c7f5881e5a
PR-URL: https://github.com/nodejs/node/pull/25709
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Myles Borins <myles.borins@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2019-01-25 19:09:26 -08:00
Myles Borins
641de82404
2019-01-24, Version 11.8.0 (Current)
...
Notable Changes:
* events:
* For unhandled `error` events with an argument that is not an
`Error` object, the resulting exeption will have more information
about the argument.
https://github.com/nodejs/node/pull/25621
* child_process:
* When the `maxBuffer` option is passed, `stdout` and `stderr` will
be truncated rather than unavailable in case of an error.
https://github.com/nodejs/node/pull/24951
* policy:
* Experimental support for module integrity checks through a manifest
file is implemented now.
https://github.com/nodejs/node/pull/23834
* n-api:
* The `napi_threadsafe_function` feature is now stable.
https://github.com/nodejs/node/pull/25556
* report:
* An experimental diagnostic API for capturing process state is
available as `process.report` and through command line flags.
https://github.com/nodejs/node/pull/22712
* tls:
* `tls.connect()` takes a `timeout` option analogous to the
`net.connect()` one.
https://github.com/nodejs/node/pull/25517
* worker:
* `process.umask()` is available as a read-only function inside Worker
threads now.
https://github.com/nodejs/node/pull/25526
* An `execArgv` option that supports a subset of Node.js command line
options is supported now.
https://github.com/nodejs/node/pull/25467
PR-URL: https://github.com/nodejs/node/pull/25687
2019-01-24 20:51:40 -05:00
Anna Henningsen
ecf693697b
doc: use correct placeholder for policy docs
...
PR-URL: https://github.com/nodejs/node/pull/25627
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com >
2019-01-21 22:52:04 +01:00
Bradley Farias
9d5fbeb55f
policy: manifest with subresource integrity checks
...
This enables code loaded via the module system to be checked for
integrity to ensure the code loaded matches expectations.
PR-URL: https://github.com/nodejs/node/pull/23834
Reviewed-By: Guy Bedford <guybedford@gmail.com >
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
2019-01-17 09:43:42 -06:00