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.

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 Big5 README Documentation #383

Merged
merged 2 commits into from
Dec 6, 2024

Conversation

IanHoang
Copy link
Collaborator

Description

It's unclear to users on how to disable target_throughput in a bash script. The following blurb is added to the Big5 README to avoid confusion. We are also working to rephrase some of the target throughput documentation in the official OSB documentation.

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

@IanHoang IanHoang added backport 2 Backport to the "2" branch backport 1 backport 3 Backport to the "3" branch ES 6 Backport to Elasticsearch 6.X branch ES 7 Backport to Elasticsearch 7.X branch and removed ES 6 Backport to Elasticsearch 6.X branch labels Sep 10, 2024
@IanHoang IanHoang added backport 7 Backport to the "7" branch and removed ES 7 Backport to Elasticsearch 7.X branch labels Sep 19, 2024
big5/README.md Outdated Show resolved Hide resolved
Signed-off-by: Ian Hoang <[email protected]>
@IanHoang IanHoang requested a review from OVI3D0 as a code owner December 6, 2024 21:25
@IanHoang IanHoang merged commit b073177 into opensearch-project:main Dec 6, 2024
2 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 6, 2024
* Add snippet documenting how to disable target_throughput when using OSB in bash script

Signed-off-by: Ian Hoang <[email protected]>

* Revise README

Signed-off-by: Ian Hoang <[email protected]>

---------

Signed-off-by: Ian Hoang <[email protected]>
(cherry picked from commit b073177)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 6, 2024
* Add snippet documenting how to disable target_throughput when using OSB in bash script

Signed-off-by: Ian Hoang <[email protected]>

* Revise README

Signed-off-by: Ian Hoang <[email protected]>

---------

Signed-off-by: Ian Hoang <[email protected]>
(cherry picked from commit b073177)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 6, 2024
* Add snippet documenting how to disable target_throughput when using OSB in bash script

Signed-off-by: Ian Hoang <[email protected]>

* Revise README

Signed-off-by: Ian Hoang <[email protected]>

---------

Signed-off-by: Ian Hoang <[email protected]>
(cherry picked from commit b073177)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Dec 6, 2024
* Add snippet documenting how to disable target_throughput when using OSB in bash script

Signed-off-by: Ian Hoang <[email protected]>

* Revise README

Signed-off-by: Ian Hoang <[email protected]>

---------

Signed-off-by: Ian Hoang <[email protected]>
(cherry picked from commit b073177)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
IanHoang pushed a commit that referenced this pull request Dec 6, 2024
* Add snippet documenting how to disable target_throughput when using OSB in bash script



* Revise README



---------


(cherry picked from commit b073177)

Signed-off-by: Ian Hoang <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
IanHoang pushed a commit that referenced this pull request Dec 6, 2024
* Add snippet documenting how to disable target_throughput when using OSB in bash script



* Revise README



---------


(cherry picked from commit b073177)

Signed-off-by: Ian Hoang <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
IanHoang pushed a commit that referenced this pull request Dec 6, 2024
* Add snippet documenting how to disable target_throughput when using OSB in bash script



* Revise README



---------


(cherry picked from commit b073177)

Signed-off-by: Ian Hoang <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
IanHoang pushed a commit that referenced this pull request Dec 6, 2024
* Add snippet documenting how to disable target_throughput when using OSB in bash script



* Revise README



---------


(cherry picked from commit b073177)

Signed-off-by: Ian Hoang <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
joshpalis pushed a commit to joshpalis/opensearch-benchmark-workloads that referenced this pull request Dec 18, 2024
* Add snippet documenting how to disable target_throughput when using OSB in bash script

Signed-off-by: Ian Hoang <[email protected]>

* Revise README

Signed-off-by: Ian Hoang <[email protected]>

---------

Signed-off-by: Ian Hoang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 1 backport 2 Backport to the "2" branch backport 3 Backport to the "3" branch backport 7 Backport to the "7" branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants