add documentation for new aggregate command + auto aggregation #8521
Conversation
Signed-off-by: Michael Oviedo <mikeovi@amazon.com>
OVI3D0
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
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. |
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
added
5 - Editorial review
There was a problem hiding this comment.
@OVI3D0 @Naarcha-AWS Please see my comments and changes and let me know if you have any questions. Thanks!
| ## Auto-aggregation | ||
|
|
||
| Auto-aggregation runs multiple iterations of benchmark tests and automatically aggregate the results, all within a single command. You can use the flags outlined in this with the `execute` command. | ||
|
|
There was a problem hiding this comment.
Above: It looks like there's a missing word in the second sentence. This what?
|
|
||
| ### Usage | ||
|
|
||
| To aggregate multiple test executions manually, you can use the aggregate command: |
There was a problem hiding this comment.
| To aggregate multiple test executions manually, you can use the aggregate command: | |
| To aggregate multiple test executions manually, you can use the `aggregate` command: |
| ### Usage | ||
|
|
||
| To aggregate multiple test executions manually, you can use the aggregate command: | ||
|
|
There was a problem hiding this comment.
Above: This sentence is a rehash of the one under the preceding heading.
There was a problem hiding this comment.
Let me change this one.
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Naarcha-AWS
added
the
6 - Done but waiting to merge
* add documentation for new aggregate command + auto aggregation Signed-off-by: Michael Oviedo <mikeovi@amazon.com> * Update aggregate.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update command-flags.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update aggregate.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: Michael Oviedo <mikeovi@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Nathan Bower <nbower@amazon.com> (cherry picked from commit c6c0041) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Description
Adds documentation for the new
aggregatecommand, introduced in OSB here, as well as automatic aggregation of test results, introduced here.Version
OpenSearch Benchmark
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.