From 54f13bb7cd8375b1855c22836c6e3ce56277dad3 Mon Sep 17 00:00:00 2001 From: Tyler Ohlsen Date: Mon, 18 Nov 2024 16:11:55 -0800 Subject: [PATCH] Refactor overview into README Signed-off-by: Tyler Ohlsen --- README.md | 6 ++++-- documentation/tutorial-11-18-2024.md | 6 +----- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index fcaffd15..937d0610 100644 --- 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, 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/tutorial-11-18-2024.md b/documentation/tutorial-11-18-2024.md index c3c8f4f6..2b49eb72 100644 --- a/documentation/tutorial-11-18-2024.md +++ b/documentation/tutorial-11-18-2024.md @@ -1,8 +1,4 @@ -The following tutorial is an accurate representation of the experimental OpenSearch Flow OSD Plugin as of 11/18/2024. - -# Overview - -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. +The following tutorial is an accurate representation of the experimental OpenSearch Flow OSD Plugin as of 11/18/2024, based on OSD 2.18. # Tutorial