From f6719c72047b03af7514882118904f4ebc27d16a Mon Sep 17 00:00:00 2001 From: Ehsan Saei <71217171+esigo@users.noreply.github.com> Date: Fri, 11 Feb 2022 22:10:53 +0100 Subject: [PATCH 1/3] benchmark documentation --- docs/performance/benchmarks.rst | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 docs/performance/benchmarks.rst diff --git a/docs/performance/benchmarks.rst b/docs/performance/benchmarks.rst new file mode 100644 index 0000000000..0e1b362462 --- /dev/null +++ b/docs/performance/benchmarks.rst @@ -0,0 +1,4 @@ +Performance Tests - Benchmarks +============================== + +Click `here `_ to view the latest performance benchmarks for packages in this repo. From 6e326f114159984e6ea724623d0f1309003a6fc3 Mon Sep 17 00:00:00 2001 From: Ehsan Saei <71217171+esigo@users.noreply.github.com> Date: Fri, 11 Feb 2022 22:20:34 +0100 Subject: [PATCH 2/3] add performance section --- docs/performance/benchmarks.rst | 2 ++ docs/public/index.rst | 8 ++++++++ 2 files changed, 10 insertions(+) diff --git a/docs/performance/benchmarks.rst b/docs/performance/benchmarks.rst index 0e1b362462..70e3da0e2f 100644 --- a/docs/performance/benchmarks.rst +++ b/docs/performance/benchmarks.rst @@ -2,3 +2,5 @@ Performance Tests - Benchmarks ============================== Click `here `_ to view the latest performance benchmarks for packages in this repo. + +Please note that the flutation in the results are mainly because [machines with different CPUs](https://github.com/benchmark-action/github-action-benchmark/issues/79) are used for tests. diff --git a/docs/public/index.rst b/docs/public/index.rst index ed9c69fab7..3103b8ca94 100644 --- a/docs/public/index.rst +++ b/docs/public/index.rst @@ -36,6 +36,14 @@ OpenTelemetry C++ otel_docs/namespace_opentelemetry__sdk__instrumentationlibrary otel_docs/namespace_opentelemetry__sdk__resource +.. toctree:: + :maxdepth: 1 + :caption: Performance + :name: performance-tests + :glob: + + performance/** + .. toctree:: :maxdepth: 1 :caption: Further Reading From 1af28a992e4e7c0b08210248bf65808b7e9a4337 Mon Sep 17 00:00:00 2001 From: esigo Date: Fri, 11 Feb 2022 22:26:47 +0100 Subject: [PATCH 3/3] fix format --- docs/performance/benchmarks.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/performance/benchmarks.rst b/docs/performance/benchmarks.rst index 70e3da0e2f..0f1044be42 100644 --- a/docs/performance/benchmarks.rst +++ b/docs/performance/benchmarks.rst @@ -3,4 +3,4 @@ Performance Tests - Benchmarks Click `here `_ to view the latest performance benchmarks for packages in this repo. -Please note that the flutation in the results are mainly because [machines with different CPUs](https://github.com/benchmark-action/github-action-benchmark/issues/79) are used for tests. +Please note that the flutation in the results are mainly because [machines with different CPUs](https://github.com/benchmark-action/github-action-benchmark/issues/79) are used for tests.