-
Notifications
You must be signed in to change notification settings - Fork 484
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
Add custom parameters benchmark page #8495
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Archer <[email protected]>
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sections for Parameter Sources and Custom Runners should be completely separate, since they pertain to entirely different items. Also, the examples should be re-written, to make them easier to understand.
We can provide new examples, but for now, the existing text should suffice. Separating the sections can perhaps be done as part of the current PR.
Signed-off-by: Archer <[email protected]>
@gkamat: I separated both files. Let me know what additional modifications you would like me to make. |
|
||
# Adding custom runners | ||
|
||
**Runners** are operation types performed on an OpenSearch cluster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For adding support for an operation that doesn't exist in OSB already.
|
||
# Adding custom parameter sources | ||
|
||
A **parameter source** is a source outside of OpenSearch Benchmark that provides parameters to an operation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A **parameter source** is a source outside of OpenSearch Benchmark that provides parameters to an operation. | |
A **parameter source** is a source outside of OpenSearch Benchmark that provides parameters to an operation. You can add parameters to an existing operation in OpenSearch Benchmark or add custom parameters to a [runner]({{site.url}}{{site.baseurl}}/benchmark/user-guide/optimizing-benchmarks/custom-runners/). |
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.