Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Benchmark index to reflect TOC #7560

Merged
merged 3 commits into from
Jun 28, 2024
Merged

Update Benchmark index to reflect TOC #7560

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2bc2cdb
Update Benchmark index to reflect TOC
Naarcha-AWS Jun 27, 2024
c6e7ef3
Apply suggestions from code review
Naarcha-AWS Jun 27, 2024
300525f
Merge branch 'main' into benchmark-index
Naarcha-AWS Jun 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions _benchmark/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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.
- [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 metrics, commands, telemetry devices, and workloads.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description should start with an action verb so that the bullets are parallel. For example, "Provides a detailed reference of...."




Expand Down
Loading