diff --git a/.github/workflows/draft-release-notes.yml b/.github/workflows/draft-release-notes.yml index 5f7106ff..8b530aa1 100644 --- a/.github/workflows/draft-release-notes.yml +++ b/.github/workflows/draft-release-notes.yml @@ -7,7 +7,7 @@ on: jobs: update_release_draft: - if: github.repository == 'opensearch-project/opensearch-ai-flow-dashboards' + if: github.repository == 'opensearch-project/dashboards-flow-framework' name: Update draft release notes runs-on: ubuntu-latest steps: diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index ad41b4e6..cf9e5e10 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -6,7 +6,7 @@ jobs: run-lint: name: Run lint script runs-on: ubuntu-latest - if: github.repository == 'opensearch-project/opensearch-ai-flow-dashboards' + if: github.repository == 'opensearch-project/dashboards-flow-framework' steps: - name: Checkout OpenSearch Dashboards uses: actions/checkout@v2 @@ -31,12 +31,12 @@ jobs: - name: Checkout plugin uses: actions/checkout@v2 with: - path: OpenSearch-Dashboards/plugins/opensearch-ai-flow-dashboards + path: OpenSearch-Dashboards/plugins/dashboards-flow-framework - name: Bootstrap the plugin run: | - cd OpenSearch-Dashboards/plugins/opensearch-ai-flow-dashboards + cd OpenSearch-Dashboards/plugins/dashboards-flow-framework yarn osd bootstrap - name: Run lint script run: | - cd OpenSearch-Dashboards/plugins/opensearch-ai-flow-dashboards + cd OpenSearch-Dashboards/plugins/dashboards-flow-framework yarn lint:es common/* public/* server/* diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index c6f78f3c..962160c0 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -25,7 +25,7 @@ You will need to install [node.js](https://nodejs.org/en/), [nvm](https://github ### Environment Setup 1. Download OpenSearch for the version that matches the [OpenSearch Dashboards version specified in package.json](./package.json#L7). -2. Download and install [OpenSearch AI Flow Framework](https://github.com/opensearch-project/opensearch-ai-flow-framework). +2. Download and install [OpenSearch Flow Framework](https://github.com/opensearch-project/flow-framework). 3. Download the OpenSearch Dashboards source code for the [version specified in package.json](./package.json#L7) you want to set up. See the [OpenSearch Dashboards contributing guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/CONTRIBUTING.md) and [developer guide](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md) for more instructions on setting up your development environment. @@ -33,7 +33,7 @@ You will need to install [node.js](https://nodejs.org/en/), [nvm](https://github 4. Change your node version to the version specified in `.node-version` inside the OpenSearch Dashboards root directory (this can be done with the `nvm use` command). 5. Create a `plugins` directory inside the OpenSearch Dashboards source code directory, if `plugins` directory doesn't exist. 6. Check out this package from version control into the `plugins` directory. -7. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards/plugins/opensearch-ai-flow-dashboards`. +7. Run `yarn osd bootstrap` inside `OpenSearch-Dashboards/plugins/dashboards-flow-framework`. Ultimately, your directory structure should look like this: @@ -42,14 +42,14 @@ Ultimately, your directory structure should look like this: . ├── OpenSearch-Dashboards │ └──plugins -│ └── opensearch-ai-flow-dashboards +│ └── dashboards-flow-framework ``` ### Build To build the plugin's distributable zip simply run `yarn build`. -Example output: `./build/opensearch-ai-flow-dashboards-2.10.0.0.zip` +Example output: `./build/dashboards-flow-framework-3.0.0.0.zip` ### Run diff --git a/README.md b/README.md index eb95a73d..fcaffd15 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -## OpenSearch AI Flow Dashboards Plugin +## OpenSearch Flow Framework Dashboards Plugin -This plugin provides a simple UI for building AI applications with OpenSearch. +This plugin provides a simple UI for building applications with OpenSearch Flow Framework. TODO: add details diff --git a/common/constants.ts b/common/constants.ts index 5cdd656c..86bacf99 100644 --- a/common/constants.ts +++ b/common/constants.ts @@ -3,9 +3,9 @@ * SPDX-License-Identifier: Apache-2.0 */ -export const PLUGIN_ID = 'aiFlowDashboards'; +export const PLUGIN_ID = 'flow-framework'; -export const BASE_NODE_API_PATH = '/api/ai_flow'; +export const BASE_NODE_API_PATH = '/api/flow_framework'; export const BASE_INDICES_NODE_API_PATH = `${BASE_NODE_API_PATH}/indices`; export const SEARCH_INDICES_PATH = `${BASE_INDICES_NODE_API_PATH}/search`; export const FETCH_INDICES_PATH = `${BASE_INDICES_NODE_API_PATH}/fetch`; diff --git a/opensearch_dashboards.json b/opensearch_dashboards.json index d865c43b..e2eb655f 100644 --- a/opensearch_dashboards.json +++ b/opensearch_dashboards.json @@ -1,10 +1,14 @@ { - "id": "aiFlowDashboards", + "id": "flowFramework", "version": "3.0.0.0", "opensearchDashboardsVersion": "3.0.0", "server": true, "ui": true, - "requiredBundles": ["opensearchDashboardsUtils"], - "requiredPlugins": ["navigation"], + "requiredBundles": [ + "opensearchDashboardsUtils" + ], + "requiredPlugins": [ + "navigation" + ], "optionalPlugins": [] -} +} \ No newline at end of file diff --git a/package.json b/package.json index 9661b2cb..f93c17e8 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,12 @@ { - "name": "ai-flow-dashboards", + "name": "dashboards-flow-framework", "version": "3.0.0.0", - "description": "OpenSearch AI Flow Dashboards Plugin", + "description": "OpenSearch Flow Framework Dashboards Plugin", "main": "index.js", "config": { "plugin_version": "3.0.0.0", - "plugin_name": "aiFlowDashboards", - "plugin_zip_name": "ai-flow-dashboards" + "plugin_name": "flowFramework", + "plugin_zip_name": "dashboards-flow-framework" }, "scripts": { "plugin-helpers": "../../scripts/use_node ../../scripts/plugin_helpers", @@ -18,7 +18,7 @@ }, "repository": { "type": "git", - "url": "https://github.com/opensearch-project/opensearch-ai-flow-dashboards.git" + "url": "https://github.com/opensearch-project/dashboards-flow-framework.git" }, "pre-commit": [ "lint:es:precommit" @@ -38,4 +38,4 @@ "pre-commit": "^1.2.2" }, "resolutions": {} -} +} \ No newline at end of file diff --git a/public/app.tsx b/public/app.tsx index 578995d2..a95902b3 100644 --- a/public/app.tsx +++ b/public/app.tsx @@ -17,14 +17,14 @@ import { interface Props extends RouteComponentProps {} -export const AiFlowDashboardsApp = (props: Props) => { +export const FlowFrameworkDashboardsApp = (props: Props) => { const sidebar = (