mirror of
https://github.com/zebrajr/node.git
synced 2025-12-06 12:20:27 +01:00
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: https://github.com/nodejs/node/issues/31741 PR-URL: https://github.com/nodejs/node/pull/31792 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
This commit is contained in:
parent
de6cbd0e37
commit
bf7409e974
|
|
@ -5,13 +5,13 @@
|
||||||
* [Pull Requests](#pull-requests)
|
* [Pull Requests](#pull-requests)
|
||||||
* [Developer's Certificate of Origin 1.1](#developers-certificate-of-origin)
|
* [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
|
The Node.js project has a
|
||||||
[Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md)
|
[Code of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md)
|
||||||
to which all contributors must adhere.
|
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)
|
## [Issues](./doc/guides/contributing/issues.md)
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@
|
||||||
* [Technical Steering Committee](#technical-steering-committee)
|
* [Technical Steering Committee](#technical-steering-committee)
|
||||||
* [TSC Meetings](#tsc-meetings)
|
* [TSC Meetings](#tsc-meetings)
|
||||||
* [Collaborator Nominations](#collaborator-nominations)
|
* [Collaborator Nominations](#collaborator-nominations)
|
||||||
* [Onboarding](#onboarding)
|
* [Onboarding](#./onboarding)
|
||||||
* [Consensus Seeking Process](#consensus-seeking-process)
|
* [Consensus Seeking Process](#consensus-seeking-process)
|
||||||
|
|
||||||
<!-- /TOC -->
|
<!-- /TOC -->
|
||||||
|
|
@ -39,7 +39,7 @@ result in Collaborators removing their opposition.
|
||||||
See:
|
See:
|
||||||
|
|
||||||
* [List of Collaborators](./README.md#current-project-team-members)
|
* [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
|
### Collaborator Activities
|
||||||
|
|
||||||
|
|
@ -148,7 +148,7 @@ nomination.
|
||||||
### Onboarding
|
### Onboarding
|
||||||
|
|
||||||
After the nomination passes, a TSC member onboards the new Collaborator. See
|
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.
|
process.
|
||||||
|
|
||||||
## Consensus Seeking Process
|
## Consensus Seeking Process
|
||||||
|
|
|
||||||
4
Makefile
4
Makefile
|
|
@ -924,12 +924,12 @@ endif
|
||||||
.PHONY: release-only
|
.PHONY: release-only
|
||||||
release-only: check-xz
|
release-only: check-xz
|
||||||
@if [ "$(DISTTYPE)" = "release" ] && `grep -q REPLACEME doc/api/*.md`; then \
|
@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 ; \
|
exit 1 ; \
|
||||||
fi
|
fi
|
||||||
@if [ "$(DISTTYPE)" = "release" ] && \
|
@if [ "$(DISTTYPE)" = "release" ] && \
|
||||||
`grep -q DEP...X doc/api/deprecations.md`; then \
|
`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 ; \
|
exit 1 ; \
|
||||||
fi
|
fi
|
||||||
@if [ "$(shell git status --porcelain | egrep -v '^\?\? ')" = "" ]; then \
|
@if [ "$(shell git status --porcelain | egrep -v '^\?\? ')" = "" ]; then \
|
||||||
|
|
|
||||||
|
|
@ -529,7 +529,7 @@ For information about the governance of the Node.js project, see
|
||||||
* [whitlockjc](https://github.com/whitlockjc) -
|
* [whitlockjc](https://github.com/whitlockjc) -
|
||||||
**Jeremy Whitlock** <jwhitlock@apache.org>
|
**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.
|
maintaining the Node.js project.
|
||||||
|
|
||||||
### Release Keys
|
### Release Keys
|
||||||
|
|
|
||||||
|
|
@ -5,7 +5,7 @@ of different Node.js implementations and different ways of
|
||||||
writing JavaScript run by the built-in JavaScript engine.
|
writing JavaScript run by the built-in JavaScript engine.
|
||||||
|
|
||||||
For a detailed guide on how to write and run benchmarks in this
|
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
|
## Table of Contents
|
||||||
|
|
||||||
|
|
@ -76,17 +76,17 @@ writing benchmarks.
|
||||||
|
|
||||||
### `createBenchmark(fn, configs[, options])`
|
### `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`
|
### `default_http_benchmarker`
|
||||||
|
|
||||||
The default benchmarker used to run HTTP benchmarks.
|
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`
|
### `PORT`
|
||||||
|
|
||||||
The default port used to run HTTP benchmarks.
|
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)`
|
### `sendResult(data)`
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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.
|
time to ensure that the changes follow the Node.js code style guide.
|
||||||
|
|
||||||
Any documentation you write (including code comments and API documentation)
|
Any documentation you write (including code comments and API documentation)
|
||||||
should follow the [Style Guide](../../STYLE_GUIDE.md). Code samples included
|
should follow the [Style Guide](../doc-style-guide.md). Code samples
|
||||||
in the API docs will also be checked when running `make lint` (or
|
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,
|
`vcbuild.bat lint` on Windows). If you are adding to or deprecating an API,
|
||||||
use `REPLACEME` for the version number in the documentation YAML.
|
use `REPLACEME` for the version number in the documentation YAML.
|
||||||
|
|
||||||
For contributing C++ code, you may want to look at the
|
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
|
[README of `src/`](../../../src/README.md) for an overview over Node.js
|
||||||
C++ internals.
|
C++ internals.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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
|
Node.js contains a compiled-in set of root certificates used as trust anchors
|
||||||
for TLS certificate validation.
|
for TLS certificate validation.
|
||||||
|
|
@ -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 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
|
[`v8.h` in V8 master]: https://github.com/v8/v8/blob/master/include/v8.h
|
||||||
[`vm` module]: https://nodejs.org/api/vm.html
|
[`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
|
[Callback scopes]: #callback-scopes
|
||||||
[JavaScript value handles]: #js-handles
|
[JavaScript value handles]: #js-handles
|
||||||
[N-API]: https://nodejs.org/api/n-api.html
|
[N-API]: https://nodejs.org/api/n-api.html
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user