mirror of
https://github.com/zebrajr/node.git
synced 2026-01-15 12:15:26 +00:00
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: https://github.com/nodejs/node/pull/30781 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This commit is contained in:
@@ -5,7 +5,7 @@ of different Node.js implementations and different ways of
|
||||
writing JavaScript run by the built-in JavaScript engine.
|
||||
|
||||
For a detailed guide on how to write and run benchmarks in this
|
||||
directory, see [the guide on benchmarks](../doc/guides/writing-and-running-benchmarks.md).
|
||||
directory, see [the guide on benchmarks](writing-and-running-benchmarks.md).
|
||||
|
||||
## Table of Contents
|
||||
|
||||
@@ -76,17 +76,17 @@ writing benchmarks.
|
||||
|
||||
### createBenchmark(fn, configs\[, options\])
|
||||
|
||||
See [the guide on writing benchmarks](../doc/guides/writing-and-running-benchmarks.md#basics-of-a-benchmark).
|
||||
See [the guide on writing benchmarks](writing-and-running-benchmarks.md#basics-of-a-benchmark).
|
||||
|
||||
### default\_http\_benchmarker
|
||||
|
||||
The default benchmarker used to run HTTP benchmarks.
|
||||
See [the guide on writing HTTP benchmarks](../doc/guides/writing-and-running-benchmarks.md#creating-an-http-benchmark).
|
||||
See [the guide on writing HTTP benchmarks](writing-and-running-benchmarks.md#creating-an-http-benchmark).
|
||||
|
||||
### PORT
|
||||
|
||||
The default port used to run HTTP benchmarks.
|
||||
See [the guide on writing HTTP benchmarks](../doc/guides/writing-and-running-benchmarks.md#creating-an-http-benchmark).
|
||||
See [the guide on writing HTTP benchmarks](writing-and-running-benchmarks.md#creating-an-http-benchmark).
|
||||
|
||||
### sendResult(data)
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ const path = require('path');
|
||||
const fs = require('fs');
|
||||
|
||||
const requirementsURL =
|
||||
'https://github.com/nodejs/node/blob/master/doc/guides/writing-and-running-benchmarks.md#http-benchmark-requirements';
|
||||
'https://github.com/nodejs/node/blob/master/benchmark/writing-and-running-benchmarks.md#http-benchmark-requirements';
|
||||
|
||||
// The port used by servers and wrk
|
||||
exports.PORT = Number(process.env.PORT) || 12346;
|
||||
|
||||
@@ -585,7 +585,7 @@ If you want to know more about the code review and the landing process, see the
|
||||
[Collaborator Guide][].
|
||||
|
||||
[approved]: #getting-approvals-for-your-pull-request
|
||||
[benchmark results]: ../writing-and-running-benchmarks.md
|
||||
[benchmark results]: ../../../benchmark/writing-and-running-benchmarks.md
|
||||
[Building guide]: ../../../BUILDING.md
|
||||
[CI (Continuous Integration) test run]: #ci-testing
|
||||
[Code of Conduct]: https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md
|
||||
|
||||
Reference in New Issue
Block a user