Commit 54c60d2
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 <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>1 parent 5d56e85 commit 54c60d2
4 files changed
Lines changed: 6 additions & 6 deletions
File tree
- benchmark
- doc/guides/contributing
| 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](../doc/guides/writing-and-running-benchmarks.md). | ||
| 8 | + directory, see [the guide on benchmarks](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](../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). | ||
| 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](../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). | ||
| 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](../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). | ||
| 90 | 90 | ||
| 91 | 91 | ### sendResult(data) | |
| 92 | 92 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -5,7 +5,7 @@ const path = require('path'); | |||
| 5 | 5 | const fs = require('fs'); | |
| 6 | 6 | ||
| 7 | 7 | 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'; | ||
| 9 | 9 | ||
| 10 | 10 | // The port used by servers and wrk | |
| 11 | 11 | exports.PORT = Number(process.env.PORT) || 12346; | |
File renamed without changes.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -585,7 +585,7 @@ If you want to know more about the code review and the landing process, see the | |||
| 585 | 585 | [Collaborator Guide][]. | |
| 586 | 586 | ||
| 587 | 587 | [approved]: #getting-approvals-for-your-pull-request | |
| 588 | - [benchmark results]: ../writing-and-running-benchmarks.md | ||
| 588 | + [benchmark results]: ../../../benchmark/writing-and-running-benchmarks.md | ||
| 589 | 589 | [Building guide]: ../../../BUILDING.md | |
| 590 | 590 | [CI (Continuous Integration) test run]: #ci-testing | |
| 591 | 591 | [Code of Conduct]: https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md | |
0 commit comments