Skip to content

Commit 1ac40dc

Browse files
Move Benchmark diagram to concepts (#9737)
* Fix Benchmark user guide metadata typo Signed-off-by: Archer <[email protected]> * Correct page Signed-off-by: Archer <[email protected]> * Add nav_excludes, move Benchmark diagram to concepts Signed-off-by: Archer <[email protected]> * Add additional fixes Signed-off-by: Archer <[email protected]> * Update _benchmark/user-guide/concepts.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> * Update concepts.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: kolchfa-aws <[email protected]>
1 parent a3f2aaa commit 1ac40dc

File tree

5 files changed

+14
-8
lines changed

5 files changed

+14
-8
lines changed

_benchmark/user-guide/concepts.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,20 @@ layout: default
33
title: Concepts
44
nav_order: 3
55
parent: User guide
6+
has_toc: false
67
redirect_from:
78
- /benchmark/user-guide/concepts/
89
---
910

1011
# Concepts
1112

12-
Before using OpenSearch Benchmark, familiarize yourself with the following concepts.
13+
Before you start using OpenSearch Benchmark, it's helpful to understand the following concepts, in order to effectively design, run, and analyze your benchmarks to evaluate OpenSearch performance under different scenarios.
14+
15+
## Benchmark architecture
16+
17+
The following diagram illustrates how OpenSearch Benchmark operates when running against a local host.
18+
19+
![Benchmark workflow]({{site.url}}{{site.baseurl}}/images/benchmark/osb-workflow.jpg).
1320

1421
## Core concepts and definitions
1522

_benchmark/user-guide/index.md

+3-7
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ layout: default
33
title: User guide
44
nav_order: 5
55
has_children: true
6-
user_cards:
6+
has_toc: false
7+
more_cards:
78
- heading: "Concepts"
89
description: "Learn core OpenSearch Benchmark concepts"
910
link: "/benchmark/user-guide/concepts/"
@@ -28,10 +29,5 @@ user_cards:
2829

2930
The OpenSearch Benchmark User Guide includes core [concepts]({{site.url}}{{site.baseurl}}/benchmark/user-guide/concepts/), [installation]({{site.url}}{{site.baseurl}}/benchmark/installing-benchmark/) instructions, and [configuration options]({{site.url}}{{site.baseurl}}/benchmark/configuring-benchmark/) to help you get the most out of OpenSearch Benchmark.
3031

31-
The following diagram visualizes how OpenSearch Benchmark works when run against a local host.
3232

33-
![Benchmark workflow]({{site.url}}{{site.baseurl}}/images/benchmark/osb-workflow.jpg).
34-
35-
## Sections
36-
37-
{% include cards.html cards=page.user_cards %}
33+
{% include cards.html cards=page.more_cards %}

_benchmark/user-guide/optimizing-benchmarks/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ title: Optimizing benchmarks
44
nav_order: 25
55
parent: User guide
66
has_children: true
7+
has_toc: false
78
more_cards:
89
- heading: "Running distributed loads"
910
description: "Configure multiple load generator machines to run large-scale benchmarks"

_benchmark/user-guide/understanding-workloads/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ layout: default
33
title: Understanding workloads
44
nav_order: 10
55
parent: User guide
6+
has_toc: false
67
has_children: true
78
items:
89
- heading: "Anatomy of a workload"

_benchmark/user-guide/working-with-workloads/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ layout: default
33
title: Working with workloads
44
nav_order: 15
55
parent: User guide
6+
has_toc: false
67
has_children: true
78
---
89

0 commit comments

Comments
 (0)