diff options
| -rw-r--r-- | CONTRIBUTING.md | 4 | ||||
| -rw-r--r-- | GOVERNANCE.md | 6 | ||||
| -rw-r--r-- | Makefile | 4 | ||||
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | benchmark/README.md | 8 | ||||
| -rw-r--r-- | doc/guides/collaborator-guide.md (renamed from COLLABORATOR_GUIDE.md) | 0 | ||||
| -rw-r--r-- | doc/guides/contributing/code-of-conduct.md (renamed from doc/guides/contributing/coc.md) | 0 | ||||
| -rw-r--r-- | doc/guides/contributing/pull-requests.md | 6 | ||||
| -rw-r--r-- | doc/guides/cpp-style-guide.md (renamed from CPP_STYLE_GUIDE.md) | 0 | ||||
| -rw-r--r-- | doc/guides/doc-style-guide.md (renamed from doc/STYLE_GUIDE.md) | 0 | ||||
| -rw-r--r-- | doc/guides/internal-api.md (renamed from doc/guides/internal/readme.md) | 0 | ||||
| -rw-r--r-- | doc/guides/maintaining-root-certs.md (renamed from doc/guides/updating-root-certs.md) | 2 | ||||
| -rw-r--r-- | doc/guides/offboarding.md (renamed from doc/offboarding.md) | 0 | ||||
| -rw-r--r-- | doc/guides/onboarding-extras.md (renamed from doc/onboarding-extras.md) | 0 | ||||
| -rw-r--r-- | doc/guides/releases.md (renamed from doc/releases.md) | 0 | ||||
| -rw-r--r-- | doc/guides/security-release-process.md (renamed from doc/guides/security_release_process.md) | 0 | ||||
| -rw-r--r-- | doc/guides/writing-and-running-benchmarks.md (renamed from benchmark/writing-and-running-benchmarks.md) | 0 | ||||
| -rw-r--r-- | onboarding.md (renamed from doc/onboarding.md) | 0 | ||||
| -rw-r--r-- | src/README.md | 2 |
19 files changed, 17 insertions, 17 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b9d1f2cef60..29700978fb7 100644 --- 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 index d7cb6e321e1..5048a700340 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) <!-- /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 @@ -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 index 657fc478a37..0576cd5132e 100644 --- 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** <jwhitlock@apache.org> -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 index c5fdad09347..cb7c1506eb6 100644 --- 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 b/doc/guides/collaborator-guide.md index 7e887d7543f..7e887d7543f 100644 --- a/COLLABORATOR_GUIDE.md +++ b/doc/guides/collaborator-guide.md diff --git a/doc/guides/contributing/coc.md b/doc/guides/contributing/code-of-conduct.md index f2c337cf509..f2c337cf509 100644 --- a/doc/guides/contributing/coc.md +++ b/doc/guides/contributing/code-of-conduct.md diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 7f4ab4e83e0..39b84bc34f1 100644 --- 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 b/doc/guides/cpp-style-guide.md index f3dcd4e647b..f3dcd4e647b 100644 --- a/CPP_STYLE_GUIDE.md +++ b/doc/guides/cpp-style-guide.md diff --git a/doc/STYLE_GUIDE.md b/doc/guides/doc-style-guide.md index f0221991b79..f0221991b79 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/guides/doc-style-guide.md diff --git a/doc/guides/internal/readme.md b/doc/guides/internal-api.md index 2631978e1af..2631978e1af 100644 --- a/doc/guides/internal/readme.md +++ b/doc/guides/internal-api.md diff --git a/doc/guides/updating-root-certs.md b/doc/guides/maintaining-root-certs.md index 41c83e5898b..d26bdad943a 100644 --- a/doc/guides/updating-root-certs.md +++ b/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 b/doc/guides/offboarding.md index 3db892b0f3d..3db892b0f3d 100644 --- a/doc/offboarding.md +++ b/doc/guides/offboarding.md diff --git a/doc/onboarding-extras.md b/doc/guides/onboarding-extras.md index a44a55987fc..a44a55987fc 100644 --- a/doc/onboarding-extras.md +++ b/doc/guides/onboarding-extras.md diff --git a/doc/releases.md b/doc/guides/releases.md index 37018e1b3fd..37018e1b3fd 100644 --- a/doc/releases.md +++ b/doc/guides/releases.md diff --git a/doc/guides/security_release_process.md b/doc/guides/security-release-process.md index c396dfad7d7..c396dfad7d7 100644 --- a/doc/guides/security_release_process.md +++ b/doc/guides/security-release-process.md diff --git a/benchmark/writing-and-running-benchmarks.md b/doc/guides/writing-and-running-benchmarks.md index 1db72d22de5..1db72d22de5 100644 --- a/benchmark/writing-and-running-benchmarks.md +++ b/doc/guides/writing-and-running-benchmarks.md diff --git a/doc/onboarding.md b/onboarding.md index 092061c0311..092061c0311 100644 --- a/doc/onboarding.md +++ b/onboarding.md diff --git a/src/README.md b/src/README.md index 40790b278ac..2e59c51c3c3 100644 --- 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 |