Skip to content

Commit d0c70f6

Browse files
committed
improve docs
1 parent 1db81d3 commit d0c70f6

4 files changed

Lines changed: 29 additions & 41 deletions

File tree

README.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,38 @@
11

2-
Extended orchestrator workflow execution form plugin example
2+
# Custom Form Plugin Example
33

4-
This repository showcases an example backstage plugin, illustrating how to to customize and extend a workflow execution form. This setup provides a Backstage instance where the plugin can be debugged before integration with the orchestrator in a Red Hat Developer Hub deployment.
4+
This repository demonstrates a Backstage plugin designed to customize and extend the workflow execution form. It provides a standalone Backstage instance for debugging and testing the plugin prior to integration with the orchestrator in a Red Hat Developer Hub deployment. The plugin’s customized features are showcased in conjunction with the [example workflow](https://github.com/parodos-dev/serverless-workflows-config/tree/main/charts/extendable-workflow). The input schema for this workflow includes custom UI properties that activate specific form enhancements. For instance, the property ["ui:widget": "CountryWidget"](https://github.com/parodos-dev/serverless-workflows-config/blob/main/charts/extendable-workflow/templates/02-configmap_01-extendable-workflow-resources-schemas.yaml#L24) directs the form to load the custom CountryWidget component provided by this plugin.
5+
56

6-
To run the plugin locally:
7+
## Getting Started
78

8-
Install Dependencies:
9+
### To Run the Plugin Locally:
910

10-
bash
11-
Copy code
11+
#### 1. Install Dependencies:
12+
13+
```bash
1214
yarn install
13-
Run the Application:
15+
```
16+
17+
#### 2. Run the Application:
1418

15-
bash
16-
Copy code
19+
```bash
1720
yarn dev
21+
```
22+
23+
### To run the plugin on RHDH deployment
24+
25+
#### 1. Install the example workflow:
26+
27+
Follow [these instructions](https://github.com/parodos-dev/serverless-workflows-config/blob/main/docs/main/extendable-workflow/README.md#persistence-pre-requisites) to install the workflow.
28+
29+
> **Note:** when running the workflow without the plugin installed, the form will throw errors.
30+
31+
#### 2. Configure RHDH to load the plugin
32+
33+
Add the following entry to the [RHDH plugins ConfigMap](https://docs.redhat.com/fr/documentation/red_hat_developer_hub/1.3/html/installing_and_viewing_dynamic_plugins/proc-config-dynamic-plugins-rhdh-operator_title-plugins-rhdh-about):
34+
35+
```yaml
36+
37+
```
1838

19-
Access: Open your browser and go to http://localhost:3000 to explore the application.

packages/README.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

plugins/README.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

plugins/custom-form-example-plugin/README.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)