From 2bc2cdb1e27c903ae8ec587dbdb1dc21a0e99e54 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Thu, 27 Jun 2024 14:20:29 -0500 Subject: [PATCH 1/2] Update Benchmark index to reflect TOC Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _benchmark/index.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/_benchmark/index.md b/_benchmark/index.md index 1a71d57de9..af2b855d95 100644 --- a/_benchmark/index.md +++ b/_benchmark/index.md @@ -24,13 +24,12 @@ The following diagram visualizes how OpenSearch Benchmark works when run against ![Benchmark workflow]({{site.url}}{{site.baseurl}}/images/benchmark/osb-workflow.jpg). -The OpenSearch Benchmark documentation is split into five sections: +The OpenSearch Benchmark documentation is split into three sections: - [Quickstart]({{site.url}}{{site.baseurl}}/benchmark/quickstart/): Learn how to quickly run and install OpenSearch Benchmark. - [User guide]({{site.url}}{{site.baseurl}}/benchmark/user-guide/index/): Dive deep into how OpenSearch Benchmark can help you track the performance of your cluster. - [Tutorials]({{site.url}}{{site.baseurl}}/benchmark/tutorials/index/): Use step-by-step guides for more advanced benchmarking configurations and functionality. -- [Commands]({{site.url}}{{site.baseurl}}/benchmark/commands/index/): A detailed reference of commands and command options supported by OpenSearch. -- [Workloads]({{site.url}}{{site.baseurl}}/benchmark/workloads/index/): A detailed reference of options available for both default and custom workloads. +- [Reference]({{site.url}}{{site.baseurl}}/benchmark/reference/index/): A detailed reference of commands, and command options, metrics, and workload options. From c6e7ef32210d20c89fe2c00ffc148b63c09b5e06 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Thu, 27 Jun 2024 16:25:34 -0500 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Heather Halter Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --- _benchmark/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_benchmark/index.md b/_benchmark/index.md index af2b855d95..6d343b908a 100644 --- a/_benchmark/index.md +++ b/_benchmark/index.md @@ -24,12 +24,12 @@ The following diagram visualizes how OpenSearch Benchmark works when run against ![Benchmark workflow]({{site.url}}{{site.baseurl}}/images/benchmark/osb-workflow.jpg). -The OpenSearch Benchmark documentation is split into three sections: +The OpenSearch Benchmark documentation is split into four sections: - [Quickstart]({{site.url}}{{site.baseurl}}/benchmark/quickstart/): Learn how to quickly run and install OpenSearch Benchmark. - [User guide]({{site.url}}{{site.baseurl}}/benchmark/user-guide/index/): Dive deep into how OpenSearch Benchmark can help you track the performance of your cluster. - [Tutorials]({{site.url}}{{site.baseurl}}/benchmark/tutorials/index/): Use step-by-step guides for more advanced benchmarking configurations and functionality. -- [Reference]({{site.url}}{{site.baseurl}}/benchmark/reference/index/): A detailed reference of commands, and command options, metrics, and workload options. +- [Reference]({{site.url}}{{site.baseurl}}/benchmark/reference/index/): A detailed reference of metrics, commands, telemetry devices, and workloads.