Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 2518213

Browse filesBrowse files
DavenportEmmaMylesBorins
DavenportEmma
authored and
MylesBorins
committed
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
Copy full SHA for 2518213
Expand file treeCollapse file tree

19 files changed

+17
-17
lines changed
Open diff view settings
Collapse file

‎CONTRIBUTING.md‎

Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2Lines changed: 2 additions & 2 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
* [Pull Requests](#pull-requests)
66
* [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin)
77

8-
## [Code of Conduct](./doc/guides/contributing/coc.md)
8+
## [Code of Conduct](./doc/guides/contributing/code-of-conduct.md)
99

1010
The Node.js project has a
1111
[Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md)
1212
to which all contributors must adhere.
1313

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).
1515

1616
## [Issues](./doc/guides/contributing/issues.md)
1717

Collapse file

‎GOVERNANCE.md‎

Copy file name to clipboardExpand all lines: GOVERNANCE.md
+3-3Lines changed: 3 additions & 3 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* [Technical Steering Committee](#technical-steering-committee)
88
* [TSC Meetings](#tsc-meetings)
99
* [Collaborator Nominations](#collaborator-nominations)
10-
* [Onboarding](#onboarding)
10+
* [Onboarding](#./onboarding)
1111
* [Consensus Seeking Process](#consensus-seeking-process)
1212

1313
<!-- /TOC -->
@@ -39,7 +39,7 @@ result in Collaborators removing their opposition.
3939
See:
4040

4141
* [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)
4343

4444
### Collaborator Activities
4545

@@ -148,7 +148,7 @@ nomination.
148148
### Onboarding
149149

150150
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
152152
process.
153153

154154
## Consensus Seeking Process
Collapse file

‎Makefile‎

Copy file name to clipboardExpand all lines: Makefile
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -924,12 +924,12 @@ endif
924924
.PHONY: release-only
925925
release-only: check-xz
926926
@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)' ; \
928928
exit 1 ; \
929929
fi
930930
@if [ "$(DISTTYPE)" = "release" ] && \
931931
`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)' ; \
933933
exit 1 ; \
934934
fi
935935
@if [ "$(shell git status --porcelain | egrep -v '^\?\? ')" = "" ]; then \
Collapse file

‎README.md‎

Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -529,7 +529,7 @@ For information about the governance of the Node.js project, see
529529
* [whitlockjc](https://github.com/whitlockjc) -
530530
**Jeremy Whitlock** &lt;jwhitlock@apache.org&gt;
531531

532-
Collaborators follow the [COLLABORATOR_GUIDE.md](./COLLABORATOR_GUIDE.md) in
532+
Collaborators follow the [Collaborator Guide](./doc/guides/collaborator-guide.md) in
533533
maintaining the Node.js project.
534534

535535
### Release Keys
Collapse file

‎benchmark/README.md‎

Copy file name to clipboardExpand all lines: benchmark/README.md
+4-4Lines changed: 4 additions & 4 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ of different Node.js implementations and different ways of
55
writing JavaScript run by the built-in JavaScript engine.
66

77
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).
99

1010
## Table of Contents
1111

@@ -76,17 +76,17 @@ writing benchmarks.
7676

7777
### `createBenchmark(fn, configs[, options])`
7878

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).
8080

8181
### `default_http_benchmarker`
8282

8383
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).
8585

8686
### `PORT`
8787

8888
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).
9090

9191
### `sendResult(data)`
9292

Collapse file

‎COLLABORATOR_GUIDE.md‎ ‎doc/guides/collaborator-guide.md‎COLLABORATOR_GUIDE.md renamed to doc/guides/collaborator-guide.md

Copy file name to clipboard
  • Display the source diff
  • Display the rich diff
File renamed without changes.
Collapse file

‎doc/guides/contributing/coc.md‎ ‎…c/guides/contributing/code-of-conduct.md‎doc/guides/contributing/coc.md renamed to doc/guides/contributing/code-of-conduct.md doc/guides/contributing/coc.md renamed to doc/guides/contributing/code-of-conduct.md

Copy file name to clipboard
  • Display the source diff
  • Display the rich diff
File renamed without changes.
Collapse file

‎doc/guides/contributing/pull-requests.md‎

Copy file name to clipboardExpand all lines: doc/guides/contributing/pull-requests.md
+3-3Lines changed: 3 additions & 3 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -115,13 +115,13 @@ If you are modifying code, please be sure to run `make lint` from time to
115115
time to ensure that the changes follow the Node.js code style guide.
116116

117117
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
120120
`vcbuild.bat lint` on Windows). If you are adding to or deprecating an API,
121121
use `REPLACEME` for the version number in the documentation YAML.
122122

123123
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
125125
[README of `src/`](../../../src/README.md) for an overview over Node.js
126126
C++ internals.
127127

Collapse file

‎CPP_STYLE_GUIDE.md‎ ‎doc/guides/cpp-style-guide.md‎CPP_STYLE_GUIDE.md renamed to doc/guides/cpp-style-guide.md

Copy file name to clipboard
  • Display the source diff
  • Display the rich diff
File renamed without changes.
Collapse file

‎doc/STYLE_GUIDE.md‎ ‎doc/guides/doc-style-guide.md‎doc/STYLE_GUIDE.md renamed to doc/guides/doc-style-guide.md

Copy file name to clipboard
  • Display the source diff
  • Display the rich diff
File renamed without changes.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.