Skip to content

Commit d68807b

Browse files
Trotttargos
authored andcommitted
doc,benchmark: move benchmark guide to benchmark directory
The doc/guides directory looks like a place for guides to using Node.js but it's actually where we store development/internal documentation. Move the benchmark guide to the benchmark directory where someone (who doesn't know that bit of somewhat-surprising information) is more likely to find it. PR-URL: #30781 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent 07ba50a commit d68807b

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

benchmark/README.md

+4-4
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](../doc/guides/writing-and-running-benchmarks.md).
8+
directory, see [the guide on benchmarks](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](../doc/guides/writing-and-running-benchmarks.md#basics-of-a-benchmark).
79+
See [the guide on writing benchmarks](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](../doc/guides/writing-and-running-benchmarks.md#creating-an-http-benchmark).
84+
See [the guide on writing HTTP benchmarks](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](../doc/guides/writing-and-running-benchmarks.md#creating-an-http-benchmark).
89+
See [the guide on writing HTTP benchmarks](writing-and-running-benchmarks.md#creating-an-http-benchmark).
9090

9191
### sendResult(data)
9292

benchmark/_http-benchmarkers.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ const path = require('path');
55
const fs = require('fs');
66

77
const requirementsURL =
8-
'https://github.com/nodejs/node/blob/master/doc/guides/writing-and-running-benchmarks.md#http-benchmark-requirements';
8+
'https://github.com/nodejs/node/blob/master/benchmark/writing-and-running-benchmarks.md#http-benchmark-requirements';
99

1010
// The port used by servers and wrk
1111
exports.PORT = Number(process.env.PORT) || 12346;

doc/guides/contributing/pull-requests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -585,7 +585,7 @@ If you want to know more about the code review and the landing process, see the
585585
[Collaborator Guide][].
586586

587587
[approved]: #getting-approvals-for-your-pull-request
588-
[benchmark results]: ../writing-and-running-benchmarks.md
588+
[benchmark results]: ../../../benchmark/writing-and-running-benchmarks.md
589589
[Building guide]: ../../../BUILDING.md
590590
[CI (Continuous Integration) test run]: #ci-testing
591591
[Code of Conduct]: https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md

0 commit comments

Comments
 (0)