Document use_case param for Create Workflow API, link to existing docs #8171
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Daniel Widdis <[email protected]>
dbwiddis
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford 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. |
|
@amitgalitz Can you give a tech review for this please? |
1 task
amitgalitz
approved these changes
Sep 4, 2024
dbwiddis
added
4 - Doc review
kolchfa-aws
approved these changes
Sep 5, 2024
There was a problem hiding this comment.
Thank you, @dbwiddis! A couple of suggestions, otherwise LGTM.
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>
|
Applying "Done but waiting to merge" label to put this in the editorial queue starting 9/11. This PR will be merged as soon as editorial review is complete. |
kolchfa-aws
added
5 - Editorial review
As this impacts previous versions, does it need to wait for the 2.17.0 queue? This may cause a merge conflict with #8172 as it is adding documentation at the same point in the diff; ideally this one can be merged first to allow for a rebase. |
natebower
reviewed
Sep 11, 2024
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Daniel Widdis <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 11, 2024
#8171) * Document use_case param for Create Workflow API, link to existing docs Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Daniel Widdis <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> (cherry picked from commit 76486a4) 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
opensearch-project#8171) * Document use_case param for Create Workflow API, link to existing docs Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Daniel Widdis <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Signed-off-by: Eric Pugh <[email protected]>
noahstaveley
pushed a commit
to noahstaveley/documentation-website
that referenced
this pull request
Sep 23, 2024
opensearch-project#8171) * Document use_case param for Create Workflow API, link to existing docs Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Update _automating-configurations/api/create-workflow.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Daniel Widdis <[email protected]> * Resolve merge conflicts Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Daniel Widdis <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Signed-off-by: Noah Staveley <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Documentation for the Create Workflow
use_caseparameter was added in 2.13.0, but the param itself was missing from the documentation for the Create Workflow API.Issues Resolved
Fixes #8167
Version
2.13 and later
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.