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

Add common operations section to User Guide. #7974

Merged
merged 4 commits into from
Sep 2, 2024

Conversation

Naarcha-AWS
Copy link
Collaborator

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.

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.

@Naarcha-AWS
Copy link
Collaborator Author

Naarcha-AWS commented Aug 12, 2024

@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.

@Naarcha-AWS Naarcha-AWS added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 3 - Tech review PR: Tech review in progress labels Aug 12, 2024
Signed-off-by: Archer <[email protected]>
@Naarcha-AWS Naarcha-AWS added 4 - Doc review PR: Doc review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Aug 26, 2024
Copy link
Contributor

@vagimeli vagimeli left a 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.
Copy link
Contributor

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?)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes.

@Naarcha-AWS Naarcha-AWS merged commit 0427252 into main Sep 2, 2024
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Sep 2, 2024
* 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>
epugh pushed a commit to o19s/documentation-website that referenced this pull request Sep 12, 2024
* 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]>
@Naarcha-AWS Naarcha-AWS deleted the benchmark-operations-reference branch December 19, 2024 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants