update some references

nodejs · Jan 14, 2022 · 9404235 · 9404235
1 parent 4325e05
commit 9404235
Show file tree

Hide file tree

Showing 22 changed files with 48 additions and 50 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -13,9 +13,7 @@
 /CODE_OF_CONDUCT.md @nodejs/tsc
 /CONTRIBUTING.md @nodejs/tsc
 /LICENSE @nodejs/tsc
-/doc/guides/contributing/*.md @nodejs/tsc
-/doc/guides/collaborator-guide.md @nodejs/tsc
-/doc/guides/offboarding.md @nodejs/tsc
+/doc/contributing/*.md @nodejs/tsc
 
 # streams
 
@@ -88,7 +86,7 @@
 
 /src/node_api* @nodejs/node-api
 /src/js_native_api* @nodejs/node-api
-/doc/guides/adding-new-napi-api.md @nodejs/node-api
+/doc/contributing/adding-new-napi-api.md @nodejs/node-api
 /doc/api/n-api.md @nodejs/node-api
 
 # gyp

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,7 +3,7 @@ Before submitting a pull request, please read
 https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md.
 
 Commit message formatting guidelines:
-https://github.com/nodejs/node/blob/HEAD/doc/guides/contributing/pull-requests.md#commit-message-guidelines
+https://github.com/nodejs/node/blob/HEAD/doc/contributing/pull-requests.md#commit-message-guidelines
 
 For code changes:
 1. Include tests for any bug fixes or new features.

diff --git a/.github/workflows/auto-start-ci.yml b/.github/workflows/auto-start-ci.yml
@@ -5,7 +5,7 @@ on:
     # Runs every five minutes (fastest the scheduler can run). Five minutes is
     # optimistic, it can take longer to run.
     # To understand why `schedule` is used instead of other events, refer to
-    # ./doc/guides/commit-queue.md
+    # ./doc/contributing/commit-queue.md
     - cron: "*/5 * * * *"
 
 env:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -5,28 +5,28 @@
 * [Pull Requests](#pull-requests)
 * [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin)
 
-## [Code of Conduct](./doc/guides/contributing/code-of-conduct.md)
+## [Code of Conduct](./doc/contributin/code-of-conduct.md)
 
 The Node.js project has a
 [Code of Conduct](https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md)
 to which all contributors must adhere.
 
-See [details on our policy on Code of Conduct](./doc/guides/contributing/code-of-conduct.md).
+See [details on our policy on Code of Conduct](./doc/contributing/code-of-conduct.md).
 
-## [Issues](./doc/guides/contributing/issues.md)
+## [Issues](./doc/contributing/issues.md)
 
-* [Asking for General Help](./doc/guides/contributing/issues.md#asking-for-general-help)
-* [Discussing non-technical topics](./doc/guides/contributing/issues.md#discussing-non-technical-topics)
-* [Submitting a Bug Report](./doc/guides/contributing/issues.md#submitting-a-bug-report)
-* [Triaging a Bug Report](./doc/guides/contributing/issues.md#triaging-a-bug-report)
+* [Asking for General Help](./doc/contributing/issues.md#asking-for-general-help)
+* [Discussing non-technical topics](./doc/contributing/issues.md#discussing-non-technical-topics)
+* [Submitting a Bug Report](./doc/contributing/issues.md#submitting-a-bug-report)
+* [Triaging a Bug Report](./doc/contributing/issues.md#triaging-a-bug-report)
 
-## [Pull Requests](./doc/guides/contributing/pull-requests.md)
+## [Pull Requests](./doc/contributing/pull-requests.md)
 
-* [Dependencies](./doc/guides/contributing/pull-requests.md#dependencies)
-* [Setting up your local environment](./doc/guides/contributing/pull-requests.md#setting-up-your-local-environment)
-* [The Process of Making Changes](./doc/guides/contributing/pull-requests.md#the-process-of-making-changes)
-* [Reviewing Pull Requests](./doc/guides/contributing/pull-requests.md#reviewing-pull-requests)
-* [Notes](./doc/guides/contributing/pull-requests.md#notes)
+* [Dependencies](./doc/contributing/pull-requests.md#dependencies)
+* [Setting up your local environment](./doc/contributing/pull-requests.md#setting-up-your-local-environment)
+* [The Process of Making Changes](./doc/contributing/pull-requests.md#the-process-of-making-changes)
+* [Reviewing Pull Requests](./doc/contributing/pull-requests.md#reviewing-pull-requests)
+* [Notes](./doc/contributing/pull-requests.md#notes)
 
 <a id="developers-certificate-of-origin"></a>
 

diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -25,7 +25,7 @@ Triagers are given the "Triage" GitHub role and have:
 See:
 
 * [List of triagers](./README.md#triagers)
-* [A guide for triagers](./doc/guides/contributing/issues.md#triaging-a-bug-report)
+* [A guide for triagers](./doc/contributing/issues.md#triaging-a-bug-report)
 
 ## Collaborators
 
@@ -54,7 +54,7 @@ result in collaborators removing their opposition.
 See:
 
 * [List of collaborators](./README.md#current-project-team-members)
-* [A guide for collaborators](./doc/guides/collaborator-guide.md)
+* [A guide for collaborators](./doc/contributing/collaborator-guide.md)
 
 ### Collaborator activities
 

diff --git a/Makefile b/Makefile
@@ -956,14 +956,14 @@ endif
 .PHONY: release-only
 release-only: check-xz
 	@if [ "$(DISTTYPE)" = "release" ] && `grep -q REPLACEME doc/api/*.md`; then \
-		echo 'Please update REPLACEME tags in the following doc/api/*.md files (See doc/guides/releases.md):\n' ; \
+		echo 'Please update REPLACEME tags in the following doc/api/*.md files (See doc/contributing/releases.md):\n' ; \
 		REPLACEMES="$(shell grep -l REPLACEME doc/api/*.md)" ; \
 		echo "$$REPLACEMES\n" | tr " " "\n" ; \
 		exit 1 ; \
 	fi
 	@if [ "$(DISTTYPE)" = "release" ] && \
 		`grep -q DEP...X doc/api/deprecations.md`; then \
-		echo 'Please update DEP...X in doc/api/deprecations.md (See doc/guides/releases.md)' ; \
+		echo 'Please update DEP...X in doc/api/deprecations.md (See doc/contributing/releases.md)' ; \
 		exit 1 ; \
 	fi
 	@if [ "$(shell git status --porcelain | egrep -v '^\?\? ')" = "" ]; then \

diff --git a/README.md b/README.md
@@ -631,7 +631,7 @@ For information about the governance of the Node.js project, see
 
 <!--lint enable prohibited-strings-->
 
-Collaborators follow the [Collaborator Guide](./doc/guides/collaborator-guide.md) in
+Collaborators follow the [Collaborator Guide](./doc/contributing/collaborator-guide.md) in
 maintaining the Node.js project.
 
 ### Triagers
@@ -737,6 +737,6 @@ license text.
 [Contributing to the project]: CONTRIBUTING.md
 [Node.js Website]: https://nodejs.org/
 [OpenJS Foundation]: https://openjsf.org/
-[Strategic initiatives]: doc/guides/strategic-initiatives.md
-[Technical values and prioritization]: doc/guides/technical-values.md
+[Strategic initiatives]: doc/contributing/strategic-initiatives.md
+[Technical values and prioritization]: doc/contributing/technical-values.md
 [Working Groups]: https://github.com/nodejs/TSC/blob/HEAD/WORKING_GROUPS.md
diff --git a/benchmark/README.md b/benchmark/README.md
@@ -5,7 +5,7 @@ of different Node.js implementations and different ways of
 writing JavaScript run by the built-in JavaScript engine.
 
 For a detailed guide on how to write and run benchmarks in this
-directory, see [the guide on benchmarks](../doc/guides/writing-and-running-benchmarks.md).
+directory, see [the guide on benchmarks](../doc/contributing/writing-and-running-benchmarks.md).
 
 ## Table of Contents
 
@@ -77,17 +77,17 @@ writing benchmarks.
 
 ### `createBenchmark(fn, configs[, options])`
 
-See [the guide on writing benchmarks](../doc/guides/writing-and-running-benchmarks.md#basics-of-a-benchmark).
+See [the guide on writing benchmarks](../doc/contributing/writing-and-running-benchmarks.md#basics-of-a-benchmark).
 
 ### `default_http_benchmarker`
 
 The default benchmarker used to run HTTP benchmarks.
-See [the guide on writing HTTP benchmarks](../doc/guides/writing-and-running-benchmarks.md#creating-an-http-benchmark).
+See [the guide on writing HTTP benchmarks](../doc/contributing/writing-and-running-benchmarks.md#creating-an-http-benchmark).
 
 ### `PORT`
 
 The default port used to run HTTP benchmarks.
-See [the guide on writing HTTP benchmarks](../doc/guides/writing-and-running-benchmarks.md#creating-an-http-benchmark).
+See [the guide on writing HTTP benchmarks](../doc/contributing/writing-and-running-benchmarks.md#creating-an-http-benchmark).
 
 ### `sendResult(data)`
 

diff --git a/deps/openssl/README.md b/deps/openssl/README.md
@@ -77,4 +77,4 @@ Please refer [config/opensslconf_asm.h](config/opensslconf_asm.h) for details.
 
 ### Upgrading OpenSSL
 
-Please refer to [maintaining-openssl](../../doc/guides/maintaining-openssl.md).
+Please refer to [maintaining-openssl](../../doc/contributing/maintaining-openssl.md).
diff --git a/doc/contributing/collaborator-guide.md b/doc/contributing/collaborator-guide.md
@@ -408,7 +408,7 @@ For pull requests introducing new core modules:
 Node-API provides an ABI-stable API guaranteed for future Node.js versions.
 Node-API additions call for unusual care and scrutiny. If a change adds to
 `node_api.h`, `js_native_api.h`, `node_api_types.h`, or `js_native_api_types.h`,
-consult [the relevant guide](https://github.com/nodejs/node/blob/HEAD/doc/guides/adding-new-napi-api.md).
+consult [the relevant guide](https://github.com/nodejs/node/blob/HEAD/doc/contributing/adding-new-napi-api.md).
 
 ### Deprecations
 

diff --git a/doc/contributing/cpp-style-guide.md b/doc/contributing/cpp-style-guide.md
@@ -403,5 +403,5 @@ even `try` and `catch` **will** break.
 [Run Time Type Information]: https://en.wikipedia.org/wiki/Run-time_type_information
 [aliased_buffer.h]: https://github.com/nodejs/node/blob/HEAD/src/aliased_buffer.h#L12
 [cppref_auto_ptr]: https://en.cppreference.com/w/cpp/memory/auto_ptr
-[errors]: https://github.com/nodejs/node/blob/HEAD/doc/guides/using-internal-errors.md
+[errors]: https://github.com/nodejs/node/blob/HEAD/doc/contributing/using-internal-errors.md
 [without C++ exception handling]: https://gcc.gnu.org/onlinedocs/libstdc++/manual/using_exceptions.html#intro.using.exception.no
diff --git a/doc/contributing/maintaining-c-ares.md b/doc/contributing/maintaining-c-ares.md
@@ -62,5 +62,5 @@ Commit the changes with a message like
 ```text
 deps: update c-ares to x.y.z
 
-Updated as described in doc/guides/maintaining-c-ares.md.
+Updated as described in doc/contributing/maintaining-c-ares.md.
 ```
diff --git a/doc/contributing/maintaining-zlib.md b/doc/contributing/maintaining-zlib.md
@@ -32,5 +32,5 @@ Commit the changes with a message like
 ```text
 deps: update zlib to upstream d7f3ca9
 
-Updated as described in doc/guides/maintaining-zlib.md.
+Updated as described in doc/contributing/maintaining-zlib.md.
 ```
diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md
@@ -202,7 +202,7 @@ When cherry-picking commits, if there are simple conflicts you can resolve
 them. Otherwise, add the `backport-requested-vN.x` label to the original PR
 and post a comment stating that it does not land cleanly and will require a
 backport PR. You can refer the owner of the PR to the "[Backporting to Release
-Lines](https://github.com/nodejs/node/blob/HEAD/doc/guides/backporting-to-release-lines.md)" guide.
+Lines](https://github.com/nodejs/node/blob/HEAD/doc/contributing/backporting-to-release-lines.md)" guide.
 
 If commits were cherry-picked in this step, check that the test still pass.
 

diff --git a/onboarding.md b/onboarding.md
@@ -253,15 +253,15 @@ needs to be pointed out separately during the onboarding.
   access to the projects coverity project as outlined in [static-analysis][].
 
 [Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md
-[Labels]: doc/guides/collaborator-guide.md#labels
-[Landing pull requests]: doc/guides/collaborator-guide.md#landing-pull-requests
+[Labels]: doc/contributing/collaborator-guide.md#labels
+[Landing pull requests]: doc/contributing/collaborator-guide.md#landing-pull-requests
 [Publicizing or hiding organization membership]: https://help.github.com/articles/publicizing-or-hiding-organization-membership/
-[`author-ready`]: doc/guides/collaborator-guide.md#author-ready-pull-requests
+[`author-ready`]: doc/contributing/collaborator-guide.md#author-ready-pull-requests
 [`core-validate-commit`]: https://github.com/nodejs/core-validate-commit
 [`git-node`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md
 [`node-core-utils`]: https://github.com/nodejs/node-core-utils
 [set up the credentials]: https://github.com/nodejs/node-core-utils#setting-up-github-credentials
-[static-analysis]: doc/guides/static-analysis.md
+[static-analysis]: doc/contributing/static-analysis.md
 [two-factor authentication]: https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/
 [using a TOTP mobile app]: https://help.github.com/articles/configuring-two-factor-authentication-via-a-totp-mobile-app/
-[who-to-cc]: doc/guides/collaborator-guide.md#who-to-cc-in-the-issue-tracker
+[who-to-cc]: doc/contributing/collaborator-guide.md#who-to-cc-in-the-issue-tracker
diff --git a/src/README.md b/src/README.md
@@ -1024,7 +1024,7 @@ static void GetUserInfo(const FunctionCallbackInfo<Value>& args) {
 }
 ```
 
-[C++ coding style]: ../doc/guides/cpp-style-guide.md
+[C++ coding style]: ../doc/contributing/cpp-style-guide.md
 [Callback scopes]: #callback-scopes
 [JavaScript value handles]: #js-handles
 [N-API]: https://nodejs.org/api/n-api.html

diff --git a/src/base_object.h b/src/base_object.h
@@ -171,7 +171,7 @@ class BaseObject : public MemoryRetainer {
   // class because it is used by src/node_postmortem_metadata.cc to calculate
   // offsets and generate debug symbols for BaseObject, which assumes that the
   // position of members in memory are predictable. For more information please
-  // refer to `doc/guides/node-postmortem-support.md`
+  // refer to `doc/contributing/node-postmortem-support.md`
   friend int GenDebugSymbols();
   friend class CleanupHookCallback;
   template <typename T, bool kIsWeak>

diff --git a/src/env.h b/src/env.h
@@ -1558,7 +1558,7 @@ class Environment : public MemoryRetainer {
   // src/node_postmortem_metadata.cc to calculate offsets and generate debug
   // symbols for Environment, which assumes that the position of members in
   // memory are predictable. For more information please refer to
-  // `doc/guides/node-postmortem-support.md`
+  // `doc/contributing/node-postmortem-support.md`
   friend int GenDebugSymbols();
   HandleWrapQueue handle_wrap_queue_;
   ReqWrapQueue req_wrap_queue_;

diff --git a/src/handle_wrap.h b/src/handle_wrap.h
@@ -106,7 +106,7 @@ class HandleWrap : public AsyncWrap {
   // class because it is used by src/node_postmortem_metadata.cc to calculate
   // offsets and generate debug symbols for HandleWrap, which assumes that the
   // position of members in memory are predictable. For more information please
-  // refer to `doc/guides/node-postmortem-support.md`
+  // refer to `doc/contributing/node-postmortem-support.md`
   friend int GenDebugSymbols();
   ListNode<HandleWrap> handle_wrap_queue_;
   enum { kInitialized, kClosing, kClosed } state_;

diff --git a/src/req_wrap.h b/src/req_wrap.h
@@ -66,7 +66,7 @@ class ReqWrap : public AsyncWrap, public ReqWrapBase {
   // members in memory are predictable. sizeof(req_) depends on the type of T,
   // so req_wrap_queue_ would no longer be at a fixed offset if it came after
   // req_. For more information please refer to
-  // `doc/guides/node-postmortem-support.md`
+  // `doc/contributing/node-postmortem-support.md`
   T req_;
 };
 

diff --git a/test/README.md b/test/README.md
@@ -3,10 +3,10 @@
 This directory contains code and data used to test the Node.js implementation.
 
 For a detailed guide on how to write tests in this
-directory, see [the guide on writing tests](../doc/guides/writing-tests.md).
+directory, see [the guide on writing tests](../doc/contributing/writing-tests.md).
 
 On how to run tests in this directory, see
-[the contributing guide](../doc/guides/contributing/pull-requests.md#step-6-test).
+[the contributing guide](../doc/contributing/pull-requests.md#step-6-test).
 
 For the tests to run on Windows, be sure to clone Node.js source code with the
 `autocrlf` git config flag set to true.

diff --git a/tools/icu/README.md b/tools/icu/README.md
@@ -27,8 +27,8 @@ Note:
 
 ## See Also
 
-* [docs/guides/maintaining-icu.md](../../doc/guides/maintaining-icu.md) for
-  information on maintaining ICU in Node.js
+* [docs/guides/maintaining-icu.md](../../doc/contributing/maintaining-icu.md)
+  for information on maintaining ICU in Node.js
 
 * [docs/api/intl.md](../../doc/api/intl.md) for information on the
   internationalization-related APIs in Node.js
Original file line number	Diff line number	Diff line change
Expand Up		@@ -77,4 +77,4 @@ Please refer [config/opensslconf_asm.h](config/opensslconf_asm.h) for details.

		### Upgrading OpenSSL

		Please refer to [maintaining-openssl](../../doc/guides/maintaining-openssl.md).
		Please refer to [maintaining-openssl](../../doc/contributing/maintaining-openssl.md).