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

[DOC] Add documentation for new OpenSearch Flow OSD plugin #9064

Open
1 of 4 tasks
ohltyler opened this issue Jan 14, 2025 · 0 comments · May be fixed by #9101
Open
1 of 4 tasks

[DOC] Add documentation for new OpenSearch Flow OSD plugin #9064

ohltyler opened this issue Jan 14, 2025 · 0 comments · May be fixed by #9101
Assignees
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.19.0

Comments

@ohltyler
Copy link
Member

ohltyler commented Jan 14, 2025

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request.
There is already backend documentation on the Flow Framework plugin (the backend plugin that powers this frontend plugin). Suggest to add documentation with an example, to show how to create a workflow for some sample use case, such as semantic search, via this new frontend plugin. This is already described in detail (with screenshots) in the tutorial. Perhaps some of the tutorial can be refactored / reused in the official documentation.

Target release date: 2.19

New APIs? No

Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.
2.19+

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
Tutorial: https://github.com/opensearch-project/dashboards-flow-framework/blob/main/documentation/tutorial.md
Repo / overview: https://github.com/opensearch-project/dashboards-flow-framework

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v2.19.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants