Add a tutorial on the plugin's current state (#484) (#486)

(cherry picked from commit a810861) Signed-off-by: Tyler Ohlsen <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-project · Nov 19, 2024 · 1249c5e · 1249c5e
1 parent 78b4dd0
commit 1249c5e
Show file tree

Hide file tree

Showing 28 changed files with 1,475 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,10 @@
 ## OpenSearch Flow Framework Dashboards Plugin
 
-This plugin provides a simple UI for building applications with OpenSearch Flow Framework.
+The OpenSearch Flow plugin on OpenSearch Dashboards (OSD) gives users the ability to iteratively build out search and ingest pipelines, initially focusing on ease-of-use for AI/ML-enhanced use cases via [ML inference processors](https://opensearch.org/docs/latest/ingest-pipelines/processors/ml-inference/). Behind the scenes, the plugin uses the [Flow Framework OpenSearch plugin](https://opensearch.org/docs/latest/automating-configurations/index/) for resource management for each use case / workflow a user creates. For example, most use cases involve configuring and creating indices, ingest pipelines, and search pipelines. All of these resources are created, updated, deleted, and maintained by the Flow Framework plugin. When users are satisfied with a use case they have built out, they can export the produced [Workflow Template](https://opensearch.org/docs/latest/automating-configurations/workflow-templates/) to re-create resources for their use cases across different clusters / data sources.
 
-TODO: add details
+For tutorials on how to leverage this plugin to build out different AI/ML use cases, see [here](./documentation/.tutorial-11-18-2024.md).
+
+For how to set up this plugin in a development environment, see [DEVELOPER_GUIDE](./DEVELOPER_GUIDE.md).
 
 ## Security
 

diff --git a/documentation/images/advanced-input-ingest-input-schema.png b/documentation/images/advanced-input-ingest-input-schema.png
diff --git a/documentation/images/advanced-input-ingest.png b/documentation/images/advanced-input-ingest.png
diff --git a/documentation/images/advanced-output-ingest-output-schema.png b/documentation/images/advanced-output-ingest-output-schema.png
diff --git a/documentation/images/advanced-output-ingest.png b/documentation/images/advanced-output-ingest.png
diff --git a/documentation/images/build-and-run-ingestion-response.png b/documentation/images/build-and-run-ingestion-response.png
diff --git a/documentation/images/buttons.png b/documentation/images/buttons.png
diff --git a/documentation/images/edit-query-term.png b/documentation/images/edit-query-term.png
diff --git a/documentation/images/enrich-data.png b/documentation/images/enrich-data.png
diff --git a/documentation/images/enrich-query-request.png b/documentation/images/enrich-query-request.png
diff --git a/documentation/images/enrich-query-results.png b/documentation/images/enrich-query-results.png
diff --git a/documentation/images/export-modal.png b/documentation/images/export-modal.png
diff --git a/documentation/images/form.png b/documentation/images/form.png
diff --git a/documentation/images/import-data-populated.png b/documentation/images/import-data-populated.png
diff --git a/documentation/images/import-data.png b/documentation/images/import-data.png
diff --git a/documentation/images/index-settings-updated.png b/documentation/images/index-settings-updated.png
diff --git a/documentation/images/index-settings.png b/documentation/images/index-settings.png
diff --git a/documentation/images/input-config-ingest.png b/documentation/images/input-config-ingest.png
diff --git a/documentation/images/inspector.png b/documentation/images/inspector.png
diff --git a/documentation/images/ml-config-ingest.png b/documentation/images/ml-config-ingest.png
diff --git a/documentation/images/output-config-ingest.png b/documentation/images/output-config-ingest.png
diff --git a/documentation/images/override-query-with-placeholders.png b/documentation/images/override-query-with-placeholders.png
diff --git a/documentation/images/override-query.png b/documentation/images/override-query.png
diff --git a/documentation/images/presets-page.png b/documentation/images/presets-page.png
diff --git a/documentation/images/search-response.png b/documentation/images/search-response.png
diff --git a/documentation/images/sidenav.png b/documentation/images/sidenav.png
diff --git a/documentation/images/workspace.png b/documentation/images/workspace.png
diff --git a/documentation/tutorial-11-18-2024.md b/documentation/tutorial-11-18-2024.md