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

[Backport 2.x] Adding Search Studio card in Search Overview Page #352

Merged
merged 1 commit into from
Sep 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion opensearch_dashboards.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
],
"optionalPlugins": [
"dataSource",
"dataSourceManagement"
"dataSourceManagement",
"contentManagement"
],
"supportedOSDataSourceVersions": ">=2.17.0 <4.0.0",
"requiredOSDataSourcePlugins": [
Expand Down
49 changes: 49 additions & 0 deletions public/general_components/service_card/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
67 changes: 67 additions & 0 deletions public/general_components/service_card/search_studio_card.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/*
* Copyright OpenSearch Contributors
* SPDX-License-Identifier: Apache-2.0
*/

import React from 'react';
import { EuiButton, EuiFlexGroup, EuiFlexItem, EuiIcon } from '@elastic/eui';
import { i18n } from '@osd/i18n';
import { PLUGIN_ID } from '../../../common';
import { ContentManagementPluginStart } from '../../../../../src/plugins/content_management/public';
import { CoreStart } from '../../../../../src/core/public';
import searchStudioIcon from './icon.svg';

export const registerSearchStudioCard = (
contentManagement: ContentManagementPluginStart,
core: CoreStart
) => {
const icon = (
<EuiIcon
size="original"
aria-label="Design and test your search solutions with ease"
type={searchStudioIcon}
/>
);

const footer = (
<EuiFlexGroup justifyContent="flexEnd">
<EuiFlexItem grow={false}>
<EuiButton
size="s"
onClick={() => {
core.application.navigateToApp(PLUGIN_ID);
}}
>
{i18n.translate('flowFrameworkDashboards.searchStudioCard.footer', {
defaultMessage: 'Try OpenSearch Studio',
})}
</EuiButton>
</EuiFlexItem>
</EuiFlexGroup>
);

contentManagement.registerContentProvider({
id: 'search_studio_card',
getContent: () => ({
id: 'search_studio',
kind: 'card',
order: 20,
title: i18n.translate('flowFrameworkDashboards.searchStudioCard.title', {
defaultMessage: 'Design and test your search solutions with ease',
}),
description: i18n.translate(
'flowFrameworkDashboards.searchStudioCard.description',
{
defaultMessage:
'OpenSearch Studio is a visual editor for creating search AI flows to power advanced search and generative AI solutions.',
}
),
getIcon: () => icon,
cardProps: {
children: footer,
layout: 'horizontal',
},
}),
getTargetArea: () => 'search_overview/config_evaluate_search',
});
};
6 changes: 5 additions & 1 deletion public/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
FlowFrameworkDashboardsPluginSetup,
AppPluginStartDependencies,
} from './types';
import { registerSearchStudioCard } from './general_components/service_card/search_studio_card';
import { PLUGIN_ID, PLUGIN_NAME } from '../common';
import {
setCore,
Expand Down Expand Up @@ -84,12 +85,15 @@ export class FlowFrameworkDashboardsPlugin

public start(
core: CoreStart,
{ navigation }: AppPluginStartDependencies
{ navigation, contentManagement }: AppPluginStartDependencies,
): FlowFrameworkDashboardsPluginStart {
setNotifications(core.notifications);
setSavedObjectsClient(core.savedObjects.client);
setNavigationUI(navigation.ui);
setApplication(core.application);
if (contentManagement) {
registerSearchStudioCard(contentManagement, core);
}
return {};
}

Expand Down
5 changes: 4 additions & 1 deletion public/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,17 @@
import { NavigationPublicPluginStart } from '../../../src/plugins/navigation/public';
import { DataSourceManagementPluginSetup } from '../../../src/plugins/data_source_management/public';
import { DataSourcePluginSetup } from '../../../src/plugins/data_source/public';
import { ContentManagementPluginStart } from '../../../src/plugins/content_management/public';

export interface FlowFrameworkDashboardsPluginSetup {
dataSourceManagement: DataSourceManagementPluginSetup;
dataSource: DataSourcePluginSetup;
}

export interface FlowFrameworkDashboardsPluginStart {}
export interface FlowFrameworkDashboardsPluginStart {
}

export interface AppPluginStartDependencies {
navigation: NavigationPublicPluginStart;
contentManagement?: ContentManagementPluginStart;
}
Loading