-
Notifications
You must be signed in to change notification settings - Fork 507
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 common operations section to User Guide. #7974
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. |
@IanHoang: Let me know if this is what you had in mind for adding operations to the User Guide. I'm also adding the rest of the reference section in this PR. |
Signed-off-by: Archer <[email protected]>
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.
Well done. LGTM.
|
||
# Common operations | ||
|
||
[Test procedures]({{site.url}}{{site.baseurl}}/benchmark/user-guide/understanding-workloads/anatomy-of-a-workload#_operations-and-_test-procedures) use a variety of operations, found inside the `operations` directory of a workload. This page details the most common operations found inside Benchmark workloads. |
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.
Should "OpenSearch" precede "Benchmark to be consistent naming convention throughout this doc (for example, line 123?)
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.
Yes.
_benchmark/user-guide/understanding-workloads/common-operations.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Naarcha-AWS <[email protected]>
* Add common operations section to User Guide. Signed-off-by: Archer <[email protected]> * Fix link Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> (cherry picked from commit 0427252) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Add common operations section to User Guide. Signed-off-by: Archer <[email protected]> * Fix link Signed-off-by: Archer <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Archer <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Eric Pugh <[email protected]>
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.