Commit 2518213
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>1 parent 9c1ac50 commit 2518213
19 files changed
Lines changed: 17 additions & 17 deletions
File tree
- benchmark
- doc/guides
- contributing
- src
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -5,13 +5,13 @@ | |||
| 5 | 5 | * [Pull Requests](#pull-requests) | |
| 6 | 6 | * [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin) | |
| 7 | 7 | ||
| 8 | - ## [Code of Conduct](./doc/guides/contributing/coc.md) | ||
| 8 | + ## [Code of Conduct](./doc/guides/contributing/code-of-conduct.md) | ||
| 9 | 9 | ||
| 10 | 10 | The Node.js project has a | |
| 11 | 11 | [Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md) | |
| 12 | 12 | to which all contributors must adhere. | |
| 13 | 13 | ||
| 14 | - See [details on our policy on Code of Conduct](./doc/guides/contributing/coc.md). | ||
| 14 | + See [details on our policy on Code of Conduct](./doc/guides/contributing/code-of-conduct.md). | ||
| 15 | 15 | ||
| 16 | 16 | ## [Issues](./doc/guides/contributing/issues.md) | |
| 17 | 17 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -7,7 +7,7 @@ | |||
| 7 | 7 | * [Technical Steering Committee](#technical-steering-committee) | |
| 8 | 8 | * [TSC Meetings](#tsc-meetings) | |
| 9 | 9 | * [Collaborator Nominations](#collaborator-nominations) | |
| 10 | - * [Onboarding](#onboarding) | ||
| 10 | + * [Onboarding](#./onboarding) | ||
| 11 | 11 | * [Consensus Seeking Process](#consensus-seeking-process) | |
| 12 | 12 | ||
| 13 | 13 | <!-- /TOC --> | |
@@ -39,7 +39,7 @@ result in Collaborators removing their opposition. | |||
| 39 | 39 | See: | |
| 40 | 40 | ||
| 41 | 41 | * [List of Collaborators](./README.md#current-project-team-members) | |
| 42 | - * [A guide for Collaborators](./COLLABORATOR_GUIDE.md) | ||
| 42 | + * [A guide for Collaborators](./doc/guides/collaborator-guide.md) | ||
| 43 | 43 | ||
| 44 | 44 | ### Collaborator Activities | |
| 45 | 45 | ||
@@ -148,7 +148,7 @@ nomination. | |||
| 148 | 148 | ### Onboarding | |
| 149 | 149 | ||
| 150 | 150 | After the nomination passes, a TSC member onboards the new Collaborator. See | |
| 151 | - [the onboarding guide](./doc/onboarding.md) for details of the onboarding | ||
| 151 | + [the onboarding guide](./onboarding.md) for details of the onboarding | ||
| 152 | 152 | process. | |
| 153 | 153 | ||
| 154 | 154 | ## Consensus Seeking Process | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -924,12 +924,12 @@ endif | |||
| 924 | 924 | .PHONY: release-only | |
| 925 | 925 | release-only: check-xz | |
| 926 | 926 | @if [ "$(DISTTYPE)" = "release" ] && `grep -q REPLACEME doc/api/*.md`; then \ | |
| 927 | - echo 'Please update REPLACEME in Added: tags in doc/api/*.md (See doc/releases.md)' ; \ | ||
| 927 | + echo 'Please update REPLACEME in Added: tags in doc/api/*.md (See doc/guides/releases.md)' ; \ | ||
| 928 | 928 | exit 1 ; \ | |
| 929 | 929 | fi | |
| 930 | 930 | @if [ "$(DISTTYPE)" = "release" ] && \ | |
| 931 | 931 | `grep -q DEP...X doc/api/deprecations.md`; then \ | |
| 932 | - echo 'Please update DEP...X in doc/api/deprecations.md (See doc/releases.md)' ; \ | ||
| 932 | + echo 'Please update DEP...X in doc/api/deprecations.md (See doc/guides/releases.md)' ; \ | ||
| 933 | 933 | exit 1 ; \ | |
| 934 | 934 | fi | |
| 935 | 935 | @if [ "$(shell git status --porcelain | egrep -v '^\?\? ')" = "" ]; then \ | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -529,7 +529,7 @@ For information about the governance of the Node.js project, see | |||
| 529 | 529 | * [whitlockjc](https://github.com/whitlockjc) - | |
| 530 | 530 | **Jeremy Whitlock** <jwhitlock@apache.org> | |
| 531 | 531 | ||
| 532 | - Collaborators follow the [COLLABORATOR_GUIDE.md](./COLLABORATOR_GUIDE.md) in | ||
| 532 | + Collaborators follow the [Collaborator Guide](./doc/guides/collaborator-guide.md) in | ||
| 533 | 533 | maintaining the Node.js project. | |
| 534 | 534 | ||
| 535 | 535 | ### Release Keys | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -5,7 +5,7 @@ of different Node.js implementations and different ways of | |||
| 5 | 5 | writing JavaScript run by the built-in JavaScript engine. | |
| 6 | 6 | ||
| 7 | 7 | For a detailed guide on how to write and run benchmarks in this | |
| 8 | - directory, see [the guide on benchmarks](writing-and-running-benchmarks.md). | ||
| 8 | + directory, see [the guide on benchmarks](../doc/guides/writing-and-running-benchmarks.md). | ||
| 9 | 9 | ||
| 10 | 10 | ## Table of Contents | |
| 11 | 11 | ||
@@ -76,17 +76,17 @@ writing benchmarks. | |||
| 76 | 76 | ||
| 77 | 77 | ### `createBenchmark(fn, configs[, options])` | |
| 78 | 78 | ||
| 79 | - See [the guide on writing benchmarks](writing-and-running-benchmarks.md#basics-of-a-benchmark). | ||
| 79 | + See [the guide on writing benchmarks](../doc/guides/contributing/writing-and-running-benchmarks.md#basics-of-a-benchmark). | ||
| 80 | 80 | ||
| 81 | 81 | ### `default_http_benchmarker` | |
| 82 | 82 | ||
| 83 | 83 | The default benchmarker used to run HTTP benchmarks. | |
| 84 | - See [the guide on writing HTTP benchmarks](writing-and-running-benchmarks.md#creating-an-http-benchmark). | ||
| 84 | + See [the guide on writing HTTP benchmarks](../doc/guides/contributing/writing-and-running-benchmarks.md#creating-an-http-benchmark). | ||
| 85 | 85 | ||
| 86 | 86 | ### `PORT` | |
| 87 | 87 | ||
| 88 | 88 | The default port used to run HTTP benchmarks. | |
| 89 | - See [the guide on writing HTTP benchmarks](writing-and-running-benchmarks.md#creating-an-http-benchmark). | ||
| 89 | + See [the guide on writing HTTP benchmarks](../doc/guides/contributing/writing-and-running-benchmarks.md#creating-an-http-benchmark). | ||
| 90 | 90 | ||
| 91 | 91 | ### `sendResult(data)` | |
| 92 | 92 | ||
File renamed without changes.
File renamed without changes.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -115,13 +115,13 @@ If you are modifying code, please be sure to run `make lint` from time to | |||
| 115 | 115 | time to ensure that the changes follow the Node.js code style guide. | |
| 116 | 116 | ||
| 117 | 117 | Any documentation you write (including code comments and API documentation) | |
| 118 | - should follow the [Style Guide](../../STYLE_GUIDE.md). Code samples included | ||
| 119 | - in the API docs will also be checked when running `make lint` (or | ||
| 118 | + should follow the [Style Guide](../doc-style-guide.md). Code samples | ||
| 119 | + included in the API docs will also be checked when running `make lint` (or | ||
| 120 | 120 | `vcbuild.bat lint` on Windows). If you are adding to or deprecating an API, | |
| 121 | 121 | use `REPLACEME` for the version number in the documentation YAML. | |
| 122 | 122 | ||
| 123 | 123 | For contributing C++ code, you may want to look at the | |
| 124 | - [C++ Style Guide](../../../CPP_STYLE_GUIDE.md), as well as the | ||
| 124 | + [C++ Style Guide](../../cpp-style-guide.md), as well as the | ||
| 125 | 125 | [README of `src/`](../../../src/README.md) for an overview over Node.js | |
| 126 | 126 | C++ internals. | |
| 127 | 127 | ||
File renamed without changes.
File renamed without changes.
0 commit comments