Add documentation for OpenSearch Flow OSD plugin #9101
Conversation
Signed-off-by: Tyler Ohlsen <[email protected]>
ohltyler
requested review from
kolchfa-aws,
Naarcha-AWS,
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. |
|
Setting PR to draft. Final doc location, wording, screenshots, & more details still in-progress. |
kolchfa-aws
added
release-notes
Signed-off-by: Tyler Ohlsen <[email protected]>
|
@opensearch-project/docs Hi team, I may need some assistance in determining the right location for the documentation for this new OSD plugin. At a high level, this plugin leverages the Flow Framework Plugin & ML Commons Plugin for building out ingest and search pipelines, so it doesn't cleanly fit as a "frontend" for particular backend/OpenSearch plugin, for example. Right now, I've put it under the Flow Framework Plugin's |
|
@kamingleung & team is working on finalizing some wording and minor UX tuning, hence I'm holding off on adding screenshots or flipping this PR out of draft just yet. |
Signed-off-by: Tyler Ohlsen <[email protected]>
Signed-off-by: Tyler Ohlsen <[email protected]>
Signed-off-by: Tyler Ohlsen <[email protected]>
Signed-off-by: Tyler Ohlsen <[email protected]>
Signed-off-by: Tyler Ohlsen <[email protected]>
|
@opensearch-project/docs, @kamingleung I've pushed changes based on the latest UX wording suggestions, and added corresponding screenshots. I will still need some assistance determining where this should live on the site; see above comment. |
Signed-off-by: Tyler Ohlsen <[email protected]>
|
Normally, we put dashboards features that are particular to a topic (say, ML), in that topic's section and not in the Dashboards section, so I think the logical section for this doc is Automating configurations. |
Signed-off-by: Tyler Ohlsen <[email protected]>
Signed-off-by: Tyler Ohlsen <[email protected]>
Signed-off-by: Tyler Ohlsen <[email protected]>
Signed-off-by: Tyler Ohlsen <[email protected]>
Signed-off-by: Tyler Ohlsen <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
There was a problem hiding this comment.
@kolchfa-aws @ohltyler Please see my comments and changes and let me know if you have any questions. Thanks!
| - For suggested models and model interfaces to use within OpenSearch Flow, see [Models](https://github.com/opensearch-project/dashboards-flow-framework/blob/main/documentation/models.md). | ||
|
|
||
| - For additional tutorials on using OpenSearch Flow to build different AI/ML use cases, see [Tutorial](https://github.com/opensearch-project/dashboards-flow-framework/blob/main/documentation/tutorial.md). | ||
|
|
There was a problem hiding this comment.
The note I deleted would be more appropriate to a blog post as opposed to the documentation.
natebower
added
5 - Editorial review
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
Description
Describe what this change achieves.
Adds initial documentation for the new OpenSearch Flow OSD plugin, including an overview, examples, and general details.
Issues Resolved
Closes #9064
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
2.19+
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
demo.webm
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.