Skip to content

Conversation

@gkamat
Copy link
Contributor

@gkamat gkamat commented Oct 31, 2025

Description

Fix incorrect links in OpenSearch Benchmark documentation. Add a FAQ page.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@github-actions
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@gkamat gkamat changed the title OSB: fix incorrect links and add a FAQ. OSB: fix incorrect links and add a FAQ Oct 31, 2025
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thanks, @gkamat! Could you rename FAQs to faqs? The convention on the doc site is to use lowercase letters for file names. Also, please see my rewording suggestions.


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:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
You also have the following options:
If you need more help, you can:


## Where are the OSB log files located?

By default, they are in the user's home directory, under `$HOME/.osb/osb.log`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
By default, they are in the user's home directory, under `$HOME/.osb/osb.log`.
By default, the OSB log files are located in the your 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).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
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).
Incremental OSB builds are generated as Docker images when any new changes are merged to the codebase. They are available on the [OpenSearch Benchmark Docker Hub page](https://hub.docker.com/r/opensearchstaging/opensearch-benchmark/tags).

@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress backport 3.3 labels Nov 3, 2025
gkamat and others added 3 commits November 7, 2025 15:07
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Govind Kamat <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Govind Kamat <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Govind Kamat <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 3.3 Doc review PR: Doc review in progress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants