doc: improve doc/markdown file organization coherence

* Updated cpp style guide file name and location and fixed links to this file. * Updated collaborator guide file name and location and fixed links to this file. * Updated documentation style guide file name and location and updated links referencing the file. * Moved files to appropriate location and updated naming style for some of them. Fixes: #31741 PR-URL: #31792 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
nodejs · Mar 4, 2020 · 2518213 · 2518213
1 parent 9c1ac50
commit 2518213
Show file tree

Hide file tree

Showing 19 changed files with 17 additions and 17 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -5,13 +5,13 @@
 * [Pull Requests](#pull-requests)
 * [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin)
 
-## [Code of Conduct](./doc/guides/contributing/coc.md)
+## [Code of Conduct](./doc/guides/contributing/code-of-conduct.md)
 
 The Node.js project has a
 [Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md)
 to which all contributors must adhere.
 
-See [details on our policy on Code of Conduct](./doc/guides/contributing/coc.md).
+See [details on our policy on Code of Conduct](./doc/guides/contributing/code-of-conduct.md).
 
 ## [Issues](./doc/guides/contributing/issues.md)
 

diff --git 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)
 
 <!-- /TOC -->
@@ -39,7 +39,7 @@ result in Collaborators removing their opposition.
 See:
 
 * [List of Collaborators](./README.md#current-project-team-members)
-* [A guide for Collaborators](./COLLABORATOR_GUIDE.md)
+* [A guide for Collaborators](./doc/guides/collaborator-guide.md)
 
 ### Collaborator Activities
 
@@ -148,7 +148,7 @@ nomination.
 ### Onboarding
 
 After the nomination passes, a TSC member onboards the new Collaborator. See
-[the onboarding guide](./doc/onboarding.md) for details of the onboarding
+[the onboarding guide](./onboarding.md) for details of the onboarding
 process.
 
 ## Consensus Seeking Process

diff --git a/Makefile b/Makefile
@@ -924,12 +924,12 @@ endif
 .PHONY: release-only
 release-only: check-xz
 	@if [ "$(DISTTYPE)" = "release" ] && `grep -q REPLACEME doc/api/*.md`; then \
-		echo 'Please update REPLACEME in Added: tags in doc/api/*.md (See doc/releases.md)' ; \
+		echo 'Please update REPLACEME in Added: tags in doc/api/*.md (See doc/guides/releases.md)' ; \
 		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/releases.md)' ; \
+		echo 'Please update DEP...X in doc/api/deprecations.md (See doc/guides/releases.md)' ; \
 		exit 1 ; \
 	fi
 	@if [ "$(shell git status --porcelain | egrep -v '^\?\? ')" = "" ]; then \

diff --git a/README.md b/README.md
@@ -529,7 +529,7 @@ For information about the governance of the Node.js project, see
 * [whitlockjc](https://github.com/whitlockjc) -
 **Jeremy Whitlock** &lt;jwhitlock@apache.org&gt;
 
-Collaborators follow the [COLLABORATOR_GUIDE.md](./COLLABORATOR_GUIDE.md) in
+Collaborators follow the [Collaborator Guide](./doc/guides/collaborator-guide.md) in
 maintaining the Node.js project.
 
 ### Release Keys

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](writing-and-running-benchmarks.md).
+directory, see [the guide on benchmarks](../doc/guides/writing-and-running-benchmarks.md).
 
 ## Table of Contents
 
@@ -76,17 +76,17 @@ writing benchmarks.
 
 ### `createBenchmark(fn, configs[, options])`
 
-See [the guide on writing benchmarks](writing-and-running-benchmarks.md#basics-of-a-benchmark).
+See [the guide on writing benchmarks](../doc/guides/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](writing-and-running-benchmarks.md#creating-an-http-benchmark).
+See [the guide on writing HTTP benchmarks](../doc/guides/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](writing-and-running-benchmarks.md#creating-an-http-benchmark).
+See [the guide on writing HTTP benchmarks](../doc/guides/contributing/writing-and-running-benchmarks.md#creating-an-http-benchmark).
 
 ### `sendResult(data)`
 

diff --git a/COLLABORATOR_GUIDE.md → doc/guides/collaborator-guide.md b/COLLABORATOR_GUIDE.md → doc/guides/collaborator-guide.md
diff --git a/doc/guides/contributing/coc.md → doc/guides/contributing/code-of-conduct.md b/doc/guides/contributing/coc.md → doc/guides/contributing/code-of-conduct.md
diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md
@@ -115,13 +115,13 @@ If you are modifying code, please be sure to run `make lint` from time to
 time to ensure that the changes follow the Node.js code style guide.
 
 Any documentation you write (including code comments and API documentation)
-should follow the [Style Guide](../../STYLE_GUIDE.md). Code samples included
-in the API docs will also be checked when running `make lint` (or
+should follow the [Style Guide](../doc-style-guide.md). Code samples
+included in the API docs will also be checked when running `make lint` (or
 `vcbuild.bat lint` on Windows). If you are adding to or deprecating an API,
 use `REPLACEME` for the version number in the documentation YAML.
 
 For contributing C++ code, you may want to look at the
-[C++ Style Guide](../../../CPP_STYLE_GUIDE.md), as well as the
+[C++ Style Guide](../../cpp-style-guide.md), as well as the
 [README of `src/`](../../../src/README.md) for an overview over Node.js
 C++ internals.
 

diff --git a/CPP_STYLE_GUIDE.md → doc/guides/cpp-style-guide.md b/CPP_STYLE_GUIDE.md → doc/guides/cpp-style-guide.md
diff --git a/doc/STYLE_GUIDE.md → doc/guides/doc-style-guide.md b/doc/STYLE_GUIDE.md → doc/guides/doc-style-guide.md
diff --git a/doc/guides/internal/readme.md → doc/guides/internal-api.md b/doc/guides/internal/readme.md → doc/guides/internal-api.md
diff --git a/doc/guides/updating-root-certs.md → doc/guides/maintaining-root-certs.md b/doc/guides/updating-root-certs.md → doc/guides/maintaining-root-certs.md
@@ -1,4 +1,4 @@
-# Updating the Root Certificates
+# Maintaining the Root Certificates
 
 Node.js contains a compiled-in set of root certificates used as trust anchors
 for TLS certificate validation.

diff --git a/doc/offboarding.md → doc/guides/offboarding.md b/doc/offboarding.md → doc/guides/offboarding.md
diff --git a/doc/onboarding-extras.md → doc/guides/onboarding-extras.md b/doc/onboarding-extras.md → doc/guides/onboarding-extras.md
diff --git a/doc/releases.md → doc/guides/releases.md b/doc/releases.md → doc/guides/releases.md
diff --git a/doc/guides/security_release_process.md → doc/guides/security-release-process.md b/doc/guides/security_release_process.md → doc/guides/security-release-process.md
diff --git a/benchmark/writing-and-running-benchmarks.md → doc/guides/writing-and-running-benchmarks.md b/benchmark/writing-and-running-benchmarks.md → doc/guides/writing-and-running-benchmarks.md
diff --git a/doc/onboarding.md → onboarding.md b/doc/onboarding.md → onboarding.md
diff --git a/src/README.md b/src/README.md
@@ -903,7 +903,7 @@ static void GetUserInfo(const FunctionCallbackInfo<Value>& args) {
 [`v8.h` in Node.js master]: https://github.com/nodejs/node/blob/master/deps/v8/include/v8.h
 [`v8.h` in V8 master]: https://github.com/v8/v8/blob/master/include/v8.h
 [`vm` module]: https://nodejs.org/api/vm.html
-[C++ coding style]: ../CPP_STYLE_GUIDE.md
+[C++ coding style]: ../doc/guides/cpp-style-guide.md
 [Callback scopes]: #callback-scopes
 [JavaScript value handles]: #js-handles
 [N-API]: https://nodejs.org/api/n-api.html