From 882b61a7eef16b373c769339e4246322b75922ad Mon Sep 17 00:00:00 2001 From: Alba Mendez Date: Tue, 31 Mar 2020 19:08:49 +0200 Subject: [PATCH] doc: fix more links 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: https://github.com/nodejs/node/pull/32586 Reviewed-By: Anna Henningsen Reviewed-By: Colin Ihrig Reviewed-By: James M Snell --- GOVERNANCE.md | 2 +- README.md | 2 +- doc/guides/collaborator-guide.md | 10 +++++----- doc/guides/doc-style-guide.md | 2 +- onboarding.md | 2 +- tools/doc/checkLinks.js | 2 ++ 6 files changed, 11 insertions(+), 9 deletions(-) diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 5048a700340617..b54f2e81b14d54 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -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) diff --git a/README.md b/README.md index 937b800ec517cd..92113f2253a5b6 100644 --- a/README.md +++ b/README.md @@ -349,7 +349,7 @@ For information about the governance of the Node.js project, see **Matteo Collina** <matteo.collina@gmail.com> (he/him) * [mhdawson](https://github.com/mhdawson) - **Michael Dawson** <michael_dawson@ca.ibm.com> (he/him) -* [mildsunrise](https://github.com/mildsunrise) +* [mildsunrise](https://github.com/mildsunrise) - **Alba Mendez** <me@alba.sh> (she/her) * [misterdjules](https://github.com/misterdjules) - **Julien Gilli** <jgilli@nodejs.org> diff --git a/doc/guides/collaborator-guide.md b/doc/guides/collaborator-guide.md index f5b4b3c10ef153..5a105b6cee8137 100644 --- a/doc/guides/collaborator-guide.md +++ b/doc/guides/collaborator-guide.md @@ -752,13 +752,13 @@ If you cannot find who to cc for a file, `git shortlog -n -s ` 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 diff --git a/doc/guides/doc-style-guide.md b/doc/guides/doc-style-guide.md index 7ee2cac4ec366f..fad23941416713 100644 --- a/doc/guides/doc-style-guide.md +++ b/doc/guides/doc-style-guide.md @@ -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 diff --git a/onboarding.md b/onboarding.md index d6cb92af868df7..4097e2850afefe 100644 --- a/onboarding.md +++ b/onboarding.md @@ -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 diff --git a/tools/doc/checkLinks.js b/tools/doc/checkLinks.js index e97eb65abebf6e..60a3f65e5ea9f1 100644 --- a/tools/doc/checkLinks.js +++ b/tools/doc/checkLinks.js @@ -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' ) {