Skip to content
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: enable remark-lint-no-literal-urls #32676

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<https://www.openssl.org/docs/man1.1.1/man3/OPENSSL_ia32cap.html> for details.

If compiling without one of the above, use `configure` with the
`--openssl-no-asm` flag. Otherwise, `configure` will fail.
Expand Down Expand Up @@ -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 <https://github.com/nodejs/node/issues/30189>.

The `-j4` option will cause `make` to run 4 simultaneous compilation jobs which
may reduce build time. For more information, see the
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!--lint disable no-literal-urls-->
<p align="center">
<a href="https://nodejs.org/">
<img
Expand Down
2 changes: 1 addition & 1 deletion doc/api/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/nodejs/node/issues/18391>
<a id="DEP0122"></a>
### DEP0122: `tls` `Server.prototype.setOptions()`
Expand Down
2 changes: 1 addition & 1 deletion doc/api/errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/nodejs/node/issues>.

<a id="ERR_INCOMPATIBLE_OPTION_PAIR"></a>
### `ERR_INCOMPATIBLE_OPTION_PAIR`
Expand Down
6 changes: 3 additions & 3 deletions doc/api/os.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<https://en.wikipedia.org/wiki/Uname#Examples> for more information.

## `os.setPriority([pid, ]priority)`
<!-- YAML
Expand Down Expand Up @@ -349,7 +349,7 @@ added: v0.3.3
Returns the operating system name as returned by [uname(3)][]. For example, it
returns `'Linux'` on Linux, `'Darwin'` on macOS, and `'Windows_NT'` on Windows.

See https://en.wikipedia.org/wiki/Uname#Examples for additional information
See <https://en.wikipedia.org/wiki/Uname#Examples> for additional information
about the output of running [uname(3)][] on various operating systems.

## `os.uptime()`
Expand Down Expand Up @@ -401,7 +401,7 @@ Returns a string identifying the kernel version.
On POSIX systems, the operating system release is determined by calling
[uname(3)][]. On Windows, `RtlGetVersion()` is used, and if it is not available,
`GetVersionExW()` will be used. See
https://en.wikipedia.org/wiki/Uname#Examples for more information.
<https://en.wikipedia.org/wiki/Uname#Examples> for more information.

## OS Constants

Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_ARCHIVE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_IOJS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_V010.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_V012.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_V10.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_V11.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_V12.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_V13.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_V4.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_V5.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_V6.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_V7.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_V8.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
1 change: 1 addition & 0 deletions doc/changelogs/CHANGELOG_V9.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!--lint disable prohibited-strings-->
<!--lint disable maximum-line-length-->
<!--lint disable no-literal-urls-->

<table>
<tr>
Expand Down
16 changes: 10 additions & 6 deletions doc/guides/cve-management-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Node.js project acts as a [Common Vulnerabilities and Exposures (CVE)
Numbering Authority (CNA)](https://cve.mitre.org/cve/cna.html).
The current scope is for all actively developed versions of software
developed under the Node.js project (ie. https://github.com/nodejs).
developed under the Node.js project (ie. <https://github.com/nodejs>).
This means that the Node.js team reviews CVE requests and if appropriate
assigns CVE numbers to vulnerabilities. The scope currently **does not**
include third party modules.
Expand All @@ -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. **[email protected]**
CVE-related issues. **[[email protected]][]**

* **Private contact points**. Administrative contacts that Mitre can reach out
to directly in case there are issues that require immediate attention.
**[email protected]**
**[[email protected]][]**

* **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.
**[email protected]**
**[[email protected]][]**

## CNA management processes

Expand Down Expand Up @@ -56,7 +56,7 @@ as outlined in the section titled `CVE Management process`.
In addition, when moving a CVE from Available such that there are less
than two remaining CVEs a new block must be requested as follows:

* Use the Mitre request form https://cveform.mitre.org/ with the
* Use the Mitre request form <https://cveform.mitre.org/> with the
option `Request a Block of IDs` to request a new block.
* The new block will be sent to the requester through email.
* Once the new block has been received, the requester will add them
Expand All @@ -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 [email protected]
When a request for a CVE is received via the [[email protected]][]
email alias the following process will be followed (likely updated
after we get HackerOne up and running).

Expand Down Expand Up @@ -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.

[[email protected]]: mailto:[email protected]
[[email protected]]: mailto:[email protected]
[[email protected]]: mailto:[email protected]
4 changes: 2 additions & 2 deletions doc/guides/maintaining-openssl.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This document describes how to update `deps/openssl/`.
## Requirements
* Linux environment
* `perl` Only Perl version 5 is tested.
* `nasm` (http://www.nasm.us/) The version of 2.11 or higher is needed.
* `nasm` (<http://www.nasm.us/>) The version of 2.11 or higher is needed.
* GNU `as` in binutils. The version of 2.26 or higher is needed.

## 0. Check Requirements
Expand All @@ -27,7 +27,7 @@ NASM version 2.11.08

## 1. Obtain and extract new OpenSSL sources

Get a new source from https://www.openssl.org/source/ and extract
Get a new source from <https://www.openssl.org/source/> and extract
all files into `deps/openssl/openssl`. Then add all files and commit
them.
```sh
Expand Down
2 changes: 1 addition & 1 deletion doc/guides/offboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Emeritus or leaves the project.
* Some teams may also require a pull request to remove the Collaborator from
a team listing. For example, if someone is removed from @nodejs/build,
they should also be removed from the Build WG README.md file in the
https://github.com/nodejs/build repository.
<https://github.com/nodejs/build> repository.
2 changes: 1 addition & 1 deletion doc/guides/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -682,7 +682,7 @@ The nodejs.org website will automatically rebuild and include the new version.
To announce the build on Twitter through the official @nodejs account, email
[[email protected]](mailto:[email protected]) with a message such as:

> v5.8.0 of @nodejs is out: https://nodejs.org/en/blog/release/v5.8.0/
> v5.8.0 of @nodejs is out: <https://nodejs.org/en/blog/release/v5.8.0/>
>
> something here about notable changes

Expand Down
4 changes: 2 additions & 2 deletions doc/guides/security-release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,6 @@ information described.
* [ ] Make sure the PRs for the vulnerabilities are closed.

[H1 CVE requests]: https://hackerone.com/nodejs/cve_requests
[docker-node]: https://github.com/nodejs/docker-node/issues)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These anchor links were incorrect with trailing bracket

[nodejs/build]: https://github.com/nodejs/build/issues)
[docker-node]: https://github.com/nodejs/docker-node/issues
[nodejs/build]: https://github.com/nodejs/build/issues
[email]: https://groups.google.com/forum/#!forum/nodejs-sec
2 changes: 1 addition & 1 deletion doc/guides/using-symbols.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Symbol-keyed properties of an object are not included in the output of
default.

Learn more about symbols at
https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol.
<https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Symbol>.

## `Symbol(string)`

Expand Down
4 changes: 2 additions & 2 deletions doc/guides/writing-and-running-benchmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ from [nghttp2.org][] or built from source.
### Benchmark Analysis Requirements

To analyze the results, `R` should be installed. Use one of the available
package managers or download it from https://www.r-project.org/.
package managers or download it from <https://www.r-project.org/>.

The R packages `ggplot2` and `plyr` are also used and can be installed using
the R REPL.
Expand All @@ -68,7 +68,7 @@ install.packages("plyr")
In the event that a message is reported stating that a CRAN mirror must be
selected first, specify a mirror by adding in the repo parameter.

If we used the "http://cran.us.r-project.org" mirror, it could look something
If we used the "<http://cran.us.r-project.org>" mirror, it could look something
like this:

```R
Expand Down
2 changes: 1 addition & 1 deletion doc/guides/writing-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,7 @@ To generate a test coverage report, see the
[Test Coverage section of the Building guide][].

Nightly coverage reports for the Node.js master branch are available at
https://coverage.nodejs.org/.
<https://coverage.nodejs.org/>.

[ASCII]: http://man7.org/linux/man-pages/man7/ascii.7.html
[Google Test]: https://github.com/google/googletest
Expand Down
2 changes: 1 addition & 1 deletion glossary.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
You may also need to check https://chromium.googlesource.com/chromiumos/docs/+/master/glossary.md.
You may also need to check <https://chromium.googlesource.com/chromiumos/docs/+/master/glossary.md>.

* LGTM: "Looks good to me", commonly used to approve a code review.
* PTAL: Please take a look.
Expand Down
4 changes: 2 additions & 2 deletions onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ onboarding session.
* It is not automatically run. You need to start it manually.
* Log in on CI is integrated with GitHub. Try to log in now!
* You will be using `node-test-pull-request` most of the time. Go there now!
* Consider bookmarking it: https://ci.nodejs.org/job/node-test-pull-request/
* Consider bookmarking it: <https://ci.nodejs.org/job/node-test-pull-request/>
* To get to the form to start a job, click on `Build with Parameters`. (If you
don't see it, that probably means you are not logged in!) Click it now!
* To start CI testing from this screen, you need to fill in two elements on
Expand Down Expand Up @@ -200,7 +200,7 @@ needs to be pointed out separately during the onboarding.
## Exercise: Make a PR adding yourself to the README

* Example:
https://github.com/nodejs/node/commit/ce986de829457c39257cd205067602e765768fb0
<https://github.com/nodejs/node/commit/ce986de829457c39257cd205067602e765768fb0>
* For raw commit message: `git log ce986de829457c39257cd205067602e765768fb0
-1`
* Collaborators are in alphabetical order by GitHub username.
Expand Down
2 changes: 1 addition & 1 deletion tools/icu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Note:
> The files in this directory were written for the Node.js v0.12 effort.
> The original intent was to merge the tools such as `icutrim.py` and `iculslocs.cc`
> back into ICU. ICU has gained its own “data slicer” tool.
> There is an issue open, https://github.com/nodejs/node/issues/25136
> There is an issue open, <https://github.com/nodejs/node/issues/25136>
> for replacing `icutrim.py` with the [ICU data slicer][].
## See Also
Expand Down