From 1004e4d90eb439517a23001ecca7f42b0382fbe2 Mon Sep 17 00:00:00 2001 From: Govind Kamat Date: Fri, 31 Oct 2025 12:04:45 -0700 Subject: [PATCH 1/4] OSB: fix incorrect links and add a FAQ. Signed-off-by: Govind Kamat --- _benchmark/FAQs.md | 30 ++++++++++++++++++++++++++++++ _benchmark/reference/index.md | 3 ++- _benchmark/user-guide/index.md | 2 +- 3 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 _benchmark/FAQs.md diff --git a/_benchmark/FAQs.md b/_benchmark/FAQs.md new file mode 100644 index 00000000000..5c95e7c0841 --- /dev/null +++ b/_benchmark/FAQs.md @@ -0,0 +1,30 @@ +--- +layout: default +title: FAQs +nav_order: 103 +--- + +# FAQs + +This is intended to be a compendium of frequently-asked questions. There are only a few currently, but additional ones will be included as the documentation is enhanced. + + +## How can I get more information about an error that I encountered? + +You can take a look at the OSB log files, towards the end, where messages for the latest run will appear. + +You also have the following options: +- [Post a question in the OpenSearch Benchmark Slack channel](https://opensearch.slack.com/archives/C082PLA3VPW). +- [Attend the Community Meeting, Office Hours, and Issue Triage](https://www.meetup.com/opensearch/events/309982456/?eventOrigin=group_upcoming_events). + + +## Where are the OSB log files located? + +By default, they are in the user's home directory, under `$HOME/.osb/osb.log`. + + +## I'm looking for the latest updates to OSB. Where can I find the latest incremental build of OSB? + +Incremental OSB builds are generated as Docker images when any new changes are merged to the codebase. They are available [here](https://hub.docker.com/r/opensearchstaging/opensearch-benchmark/tags). + + diff --git a/_benchmark/reference/index.md b/_benchmark/reference/index.md index 8dc56059574..1322dcf0d8e 100644 --- a/_benchmark/reference/index.md +++ b/_benchmark/reference/index.md @@ -10,4 +10,5 @@ redirect_from: # Reference -The following section contains reference materials for commands, metrics, and workloads for OpenSearch Benchmark. \ No newline at end of file +The following section contains reference materials for [commands]({{site.url}}{{site.baseurl}}/benchmark/reference/commands/), [metrics]({{site.url}}{{site.baseurl}}/benchmark/reference/metrics/), and [workloads]({{site.url}}{{site.baseurl}}/benchmark/reference/workloads/) for OpenSearch Benchmark. + diff --git a/_benchmark/user-guide/index.md b/_benchmark/user-guide/index.md index fc6486f573b..0f56047e236 100644 --- a/_benchmark/user-guide/index.md +++ b/_benchmark/user-guide/index.md @@ -32,7 +32,7 @@ redirect_from: # OpenSearch Benchmark User Guide -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. +The OpenSearch Benchmark User Guide includes core [concepts]({{site.url}}{{site.baseurl}}/benchmark/user-guide/concepts/), [installation instructions]({{site.url}}{{site.baseurl}}/benchmark/installing-benchmark/), and [configuration options]({{site.url}}{{site.baseurl}}/benchmark/configuring-benchmark/) to help you get the most out of OpenSearch Benchmark. {% include cards.html cards=page.more_cards %} \ No newline at end of file From 5f5714987689492b46196c7aa9fc693b34a4049e Mon Sep 17 00:00:00 2001 From: Govind Kamat Date: Fri, 7 Nov 2025 15:07:58 -0800 Subject: [PATCH 2/4] Update _benchmark/FAQs.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Govind Kamat --- _benchmark/FAQs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_benchmark/FAQs.md b/_benchmark/FAQs.md index 5c95e7c0841..7cf547918e3 100644 --- a/_benchmark/FAQs.md +++ b/_benchmark/FAQs.md @@ -11,7 +11,7 @@ This is intended to be a compendium of frequently-asked questions. There are on ## How can I get more information about an error that I encountered? -You can take a look at the OSB log files, towards the end, where messages for the latest run will appear. +Check the end of the OSB log files to view messages from the latest run. You also have the following options: - [Post a question in the OpenSearch Benchmark Slack channel](https://opensearch.slack.com/archives/C082PLA3VPW). From 7b36cdba4aaa12eeaab36a87c75eb2bc15564012 Mon Sep 17 00:00:00 2001 From: Govind Kamat Date: Fri, 7 Nov 2025 15:08:14 -0800 Subject: [PATCH 3/4] Update _benchmark/FAQs.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Govind Kamat --- _benchmark/FAQs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_benchmark/FAQs.md b/_benchmark/FAQs.md index 7cf547918e3..7dcdc5c19c4 100644 --- a/_benchmark/FAQs.md +++ b/_benchmark/FAQs.md @@ -15,7 +15,7 @@ Check the end of the OSB log files to view messages from the latest run. You also have the following options: - [Post a question in the OpenSearch Benchmark Slack channel](https://opensearch.slack.com/archives/C082PLA3VPW). -- [Attend the Community Meeting, Office Hours, and Issue Triage](https://www.meetup.com/opensearch/events/309982456/?eventOrigin=group_upcoming_events). +- [Attend the community meeting, office hours, or issue triage session](https://www.meetup.com/opensearch/events/309982456/?eventOrigin=group_upcoming_events). ## Where are the OSB log files located? From d35d3c3d2c184e5a121bd0bd82981ce2d81723ae Mon Sep 17 00:00:00 2001 From: Govind Kamat Date: Fri, 7 Nov 2025 15:08:27 -0800 Subject: [PATCH 4/4] Update _benchmark/FAQs.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Govind Kamat --- _benchmark/FAQs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_benchmark/FAQs.md b/_benchmark/FAQs.md index 7dcdc5c19c4..09e360f12e0 100644 --- a/_benchmark/FAQs.md +++ b/_benchmark/FAQs.md @@ -6,7 +6,7 @@ nav_order: 103 # FAQs -This is intended to be a compendium of frequently-asked questions. There are only a few currently, but additional ones will be included as the documentation is enhanced. +This section provides answers to frequently asked questions. ## How can I get more information about an error that I encountered?