Skip to content

Commit d3b7841

Browse files
update ai-experience plugin README file (#636)
1 parent fc9ce7c commit d3b7841

1 file changed

Lines changed: 41 additions & 1 deletion

File tree

  • workspaces/ai-integrations/plugins/ai-experience

workspaces/ai-integrations/plugins/ai-experience/README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Welcome to the ai-experience plugin!
44

5-
_This plugin was created through the Backstage CLI_
5+
This plugin enhances the homepage experience for the RHDH AI flavour to provide users with better visibility into the AI-related assets, tools and resources at their disposal.
66

77
## Getting started
88

@@ -11,3 +11,43 @@ Your plugin has been added to the example app in this repository, meaning you'll
1111
You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
1212
This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
1313
It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory.
14+
15+
## For Administrators
16+
17+
### Prerequisites
18+
19+
Before installing the frontend plugin, ensure that the AI experience backend is integrated into your Backstage instance. Follow the [AI experience backend plugin README](https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/ai-integrations/plugins/ai-experience-backend/README.md) for setup instructions.
20+
21+
### Installation
22+
23+
To install the AI experience plugin, run the following command:
24+
25+
```sh
26+
yarn workspace app add @red-hat-developer-hub/backstage-plugin-ai-experience
27+
```
28+
29+
### Configuration
30+
31+
1. Update `/home` Route with the **AI Experience** page in `packages/app/src/App.tsx`:
32+
33+
```tsx
34+
import { AiExperiencePage } from '@red-hat-developer-hub/backstage-plugin-ai-experience';
35+
36+
<Route path="/home" element={<AiExperiencePage />} />;
37+
```
38+
39+
## For Users
40+
41+
### Using the AI experience Plugin
42+
43+
The AI experience plugin allows users to explore AI-related assets, tools and resources.
44+
45+
#### Prerequisites
46+
47+
- A running Backstage application.
48+
- The AI experience plugin is installed and configured. See [Installation](#installation) for setup instructions.
49+
50+
#### Accessing the Plugin
51+
52+
1. Open your Backstage application.
53+
2. Explore AI-related resources from the home page.

0 commit comments

Comments
 (0)