Skip to content

Commit

Permalink
doc: fix more links
Browse files Browse the repository at this point in the history
Fix broken links found by the checker, and exclude
test/fixtures as it contains invalid links.

Also exclude doc/changelogs because they're huge files
which take very long to parse, and (IIRC) are auto-generated
anyway.

(Oh and also a nit at the README next to my link)

PR-URL: #32586
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
mildsunrise committed Apr 2, 2020
1 parent 77f9e0c commit 882b61a
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 9 deletions.
2 changes: 1 addition & 1 deletion GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* [Technical Steering Committee](#technical-steering-committee)
* [TSC Meetings](#tsc-meetings)
* [Collaborator Nominations](#collaborator-nominations)
* [Onboarding](#./onboarding)
* [Onboarding](#onboarding)
* [Consensus Seeking Process](#consensus-seeking-process)

<!-- /TOC -->
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ For information about the governance of the Node.js project, see
**Matteo Collina** &lt;matteo.collina@gmail.com&gt; (he/him)
* [mhdawson](https://github.com/mhdawson) -
**Michael Dawson** &lt;michael_dawson@ca.ibm.com&gt; (he/him)
* [mildsunrise](https://github.com/mildsunrise)
* [mildsunrise](https://github.com/mildsunrise) -
**Alba Mendez** &lt;me@alba.sh&gt; (she/her)
* [misterdjules](https://github.com/misterdjules) -
**Julien Gilli** &lt;jgilli@nodejs.org&gt;
Expand Down
10 changes: 5 additions & 5 deletions doc/guides/collaborator-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -752,13 +752,13 @@ If you cannot find who to cc for a file, `git shortlog -n -s <file>` may help.

["Merge Pull Request"]: https://help.github.com/articles/merging-a-pull-request/#merging-a-pull-request-on-github
[Deprecation]: https://en.wikipedia.org/wiki/Deprecation
[Stability Index]: doc/api/documentation.md#stability-index
[Stability Index]: ../api/documentation.md#stability-index
[TSC]: https://github.com/nodejs/TSC
[`--pending-deprecation`]: doc/api/cli.md#--pending-deprecation
[`--throw-deprecation`]: doc/api/cli.md#--throw-deprecation
[`--pending-deprecation`]: ../api/cli.md#--pending-deprecation
[`--throw-deprecation`]: ../api/cli.md#--throw-deprecation
[`node-core-utils`]: https://github.com/nodejs/node-core-utils
[backporting guide]: doc/guides/backporting-to-release-lines.md
[commit message guidelines]: ./doc/guides/contributing/pull-requests.md#commit-message-guidelines
[backporting guide]: backporting-to-release-lines.md
[commit message guidelines]: contributing/pull-requests.md#commit-message-guidelines
[commit-example]: https://github.com/nodejs/node/commit/b636ba8186
[git-node]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md
[git-node-metadata]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md#git-node-metadata
Expand Down
2 changes: 1 addition & 1 deletion doc/guides/doc-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ See also API documentation structure overview in [doctools README][].
[Javascript type]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Grammar_and_types#Data_structures_and_types
[serial commas]: https://en.wikipedia.org/wiki/Serial_comma
[plugin]: https://editorconfig.org/#download
[doctools README]: ../tools/doc/README.md
[doctools README]: ../../tools/doc/README.md
2 changes: 1 addition & 1 deletion onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ onboarding session.
organization (not just Collaborators on Node.js core) have access. Its
contents should not be shared externally.
* You can find the full moderation policy
[here](https://github.com/nodejs/TSC/blob/master/Moderation-Policy.md).
[here](https://github.com/nodejs/admin/blob/master/Moderation-Policy.md).

## Reviewing PRs

Expand Down
2 changes: 2 additions & 0 deletions tools/doc/checkLinks.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ function findMarkdownFilesRecursively(dirPath) {
if (
entry.isDirectory() &&
entry.name !== 'api' &&
entry.name !== 'fixtures' &&
entry.name !== 'changelogs' &&
entry.name !== 'deps' &&
entry.name !== 'node_modules'
) {
Expand Down

0 comments on commit 882b61a

Please sign in to comment.