From a6cfc1d150c8c82e48f7d66ccbb6a0f7a14e8feb Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Sun, 5 Apr 2020 23:26:24 -0400 Subject: [PATCH 1/4] doc: add angle brackets around implicit links --- BUILDING.md | 4 ++-- doc/api/deprecations.md | 2 +- doc/api/errors.md | 2 +- doc/api/os.md | 6 +++--- doc/guides/cve-management-process.md | 4 ++-- doc/guides/maintaining-openssl.md | 4 ++-- doc/guides/offboarding.md | 2 +- doc/guides/releases.md | 2 +- doc/guides/security-release-process.md | 4 ++-- doc/guides/using-symbols.md | 2 +- doc/guides/writing-and-running-benchmarks.md | 4 ++-- doc/guides/writing-tests.md | 2 +- glossary.md | 2 +- onboarding.md | 4 ++-- tools/icu/README.md | 2 +- 15 files changed, 23 insertions(+), 23 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index a4a00a9f1ffe49..a7dc040f5f385e 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -204,7 +204,7 @@ For use of AVX2, * nasm version 2.10 or higher in Windows Please refer to - https://www.openssl.org/docs/man1.1.1/man3/OPENSSL_ia32cap.html for details. + for details. If compiling without one of the above, use `configure` with the `--openssl-no-asm` flag. Otherwise, `configure` will fail. @@ -277,7 +277,7 @@ $ make -j4 If you run into a `No module named 'distutils.spawn'` error when executing `./configure`, please try `python3 -m pip install --upgrade setuptools` or `sudo apt install python3-distutils -y`. -For more information, see https://github.com/nodejs/node/issues/30189. +For more information, see . The `-j4` option will cause `make` to run 4 simultaneous compilation jobs which may reduce build time. For more information, see the diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index f2a82ce1dd5395..eb055d4c414281 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -2352,7 +2352,7 @@ The undocumented `net._setSimultaneousAccepts()` function was originally intended for debugging and performance tuning when using the `child_process` and `cluster` modules on Windows. The function is not generally useful and is being removed. See discussion here: -https://github.com/nodejs/node/issues/18391 + ### DEP0122: `tls` `Server.prototype.setOptions()` diff --git a/doc/api/errors.md b/doc/api/errors.md index 5308490b88fe8c..480bbdfbd23e42 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -1194,7 +1194,7 @@ is set for the `Http2Stream`. ### `ERR_INTERNAL_ASSERTION` There was a bug in Node.js or incorrect usage of Node.js internals. -To fix the error, open an issue at https://github.com/nodejs/node/issues. +To fix the error, open an issue at . ### `ERR_INCOMPATIBLE_OPTION_PAIR` diff --git a/doc/api/os.md b/doc/api/os.md index 27a7c3d549f78b..e2cce1f8a5580f 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -290,7 +290,7 @@ Returns the operating system as a string. On POSIX systems, the operating system release is determined by calling [uname(3)][]. On Windows, `GetVersionExW()` is used. See -https://en.wikipedia.org/wiki/Uname#Examples for more information. + for more information. ## `os.setPriority([pid, ]priority)` + diff --git a/doc/changelogs/CHANGELOG_IOJS.md b/doc/changelogs/CHANGELOG_IOJS.md index e736a70dedfef2..0a650253182b6d 100644 --- a/doc/changelogs/CHANGELOG_IOJS.md +++ b/doc/changelogs/CHANGELOG_IOJS.md @@ -2,6 +2,7 @@ +
diff --git a/doc/changelogs/CHANGELOG_V010.md b/doc/changelogs/CHANGELOG_V010.md index 65b6bef55bbd20..d4b579e6b5b88b 100644 --- a/doc/changelogs/CHANGELOG_V010.md +++ b/doc/changelogs/CHANGELOG_V010.md @@ -2,6 +2,7 @@ +
diff --git a/doc/changelogs/CHANGELOG_V012.md b/doc/changelogs/CHANGELOG_V012.md index 8a5ebf3e429fa6..d0485ffc58f652 100644 --- a/doc/changelogs/CHANGELOG_V012.md +++ b/doc/changelogs/CHANGELOG_V012.md @@ -2,6 +2,7 @@ +
diff --git a/doc/changelogs/CHANGELOG_V10.md b/doc/changelogs/CHANGELOG_V10.md index e347b51619e6d8..8a3baae0a53c57 100644 --- a/doc/changelogs/CHANGELOG_V10.md +++ b/doc/changelogs/CHANGELOG_V10.md @@ -2,6 +2,7 @@ +
diff --git a/doc/changelogs/CHANGELOG_V11.md b/doc/changelogs/CHANGELOG_V11.md index 960276df5e0293..be1cd8102e74a5 100644 --- a/doc/changelogs/CHANGELOG_V11.md +++ b/doc/changelogs/CHANGELOG_V11.md @@ -2,6 +2,7 @@ +
diff --git a/doc/changelogs/CHANGELOG_V12.md b/doc/changelogs/CHANGELOG_V12.md index 28e0c6ec306316..e3a457c39f18c6 100644 --- a/doc/changelogs/CHANGELOG_V12.md +++ b/doc/changelogs/CHANGELOG_V12.md @@ -2,6 +2,7 @@ +
diff --git a/doc/changelogs/CHANGELOG_V13.md b/doc/changelogs/CHANGELOG_V13.md index 3c2d64e2d960ee..285120dcae8ebf 100644 --- a/doc/changelogs/CHANGELOG_V13.md +++ b/doc/changelogs/CHANGELOG_V13.md @@ -2,6 +2,7 @@ +
diff --git a/doc/changelogs/CHANGELOG_V4.md b/doc/changelogs/CHANGELOG_V4.md index 2f5c81319025c7..69f36cf2cea9d9 100644 --- a/doc/changelogs/CHANGELOG_V4.md +++ b/doc/changelogs/CHANGELOG_V4.md @@ -2,6 +2,7 @@ +
diff --git a/doc/changelogs/CHANGELOG_V5.md b/doc/changelogs/CHANGELOG_V5.md index ac338886c858c6..c9cd28d692bfaf 100644 --- a/doc/changelogs/CHANGELOG_V5.md +++ b/doc/changelogs/CHANGELOG_V5.md @@ -2,6 +2,7 @@ +
diff --git a/doc/changelogs/CHANGELOG_V6.md b/doc/changelogs/CHANGELOG_V6.md index 763ff802884781..20c9370ff0d5ab 100644 --- a/doc/changelogs/CHANGELOG_V6.md +++ b/doc/changelogs/CHANGELOG_V6.md @@ -2,6 +2,7 @@ +
diff --git a/doc/changelogs/CHANGELOG_V7.md b/doc/changelogs/CHANGELOG_V7.md index 5a06890f58685b..a64b973c8c2192 100644 --- a/doc/changelogs/CHANGELOG_V7.md +++ b/doc/changelogs/CHANGELOG_V7.md @@ -2,6 +2,7 @@ +
diff --git a/doc/changelogs/CHANGELOG_V8.md b/doc/changelogs/CHANGELOG_V8.md index 33fa32948389b6..41e38efcf57206 100644 --- a/doc/changelogs/CHANGELOG_V8.md +++ b/doc/changelogs/CHANGELOG_V8.md @@ -2,6 +2,7 @@ +
diff --git a/doc/changelogs/CHANGELOG_V9.md b/doc/changelogs/CHANGELOG_V9.md index f58341bb34b52d..e4cdf50a9381b6 100644 --- a/doc/changelogs/CHANGELOG_V9.md +++ b/doc/changelogs/CHANGELOG_V9.md @@ -2,6 +2,7 @@ +
From 96e7c55179448a51af30c485dda49a242b38be7a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 22 Apr 2020 22:46:00 -0400 Subject: [PATCH 3/4] doc: convert bare email addresses to mailto links reflowed for line length after increased url size --- doc/guides/cve-management-process.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/guides/cve-management-process.md b/doc/guides/cve-management-process.md index 36c2b3a6ca38f0..eba94484b53877 100644 --- a/doc/guides/cve-management-process.md +++ b/doc/guides/cve-management-process.md @@ -18,17 +18,17 @@ of contact points. Email aliases have been setup for these as follows: * **Public contact points**. Email address to which people will be directed by Mitre when they are asked for a way to contact the Node.js team about - CVE-related issues. **cve-request@iojs.org** + CVE-related issues. **[cve-request@iojs.org][]** * **Private contact points**. Administrative contacts that Mitre can reach out to directly in case there are issues that require immediate attention. - **cve-mitre-contact@iojs.org** + **[cve-mitre-contact@iojs.org][]** * **Email addresses to add to the CNA email discussion list**. This address has been added to a closed mailing list that is used for announcements, sharing documents, or discussion relevant to the CNA community. The list rarely has more than ten messages a week. - **cna-discussion-list@iojs.org** + **[cna-discussion-list@iojs.org][]** ## CNA management processes @@ -72,7 +72,7 @@ of CVEs should then be requested using the steps listed above. ### External CVE request process -When a request for a CVE is received via the cve-request@iojs.org +When a request for a CVE is received via the [cve-request@iojs.org][] email alias the following process will be followed (likely updated after we get HackerOne up and running). @@ -135,3 +135,7 @@ following steps are used to assign, announce and report a CVE. * Move the CVE from the Pending section to the Announced section along with a link to the Node.js blog post announcing that releases are available. + +[cve-request@iojs.org]: mailto:cve-request@iojs.org +[cve-mitre-contact@iojs.org]: mailto:cve-mitre-contact@iojs.org +[cna-discussion-list@iojs.org]: mailto:cna-discussion-list@iojs.org From 8b047bc81acf724ec6d30f81c56c675c3284ca2b Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 22 Apr 2020 22:50:49 -0400 Subject: [PATCH 4/4] doc: ignore no-literal-urls in README Membership lists are currently formatted in a specific way for tooling --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0048be118c988c..0542c5c7b26a11 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +