You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: workspaces/orchestrator/docs/extensibleForm.md
+7-13Lines changed: 7 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ This decorator supports overriding a selected set of [react-json-schema-form pro
13
13
The custom decorator is delivered via a factory method that leverages a [Backstage utility API](https://backstage.io/docs/api/utility-apis) provided by the orchestrator.
14
14
To trigger the desired behavior, the workflow schema should include custom UI properties.
15
15
16
-
For reference, an example plugin can be found [here](https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/orchestrator/plugins/orchestrator-form-widgets).
16
+
For reference, an example plugin can be found [here](../plugins/orchestrator-form-widgets).
17
17
18
18
## API
19
19
@@ -32,7 +32,7 @@ export type FormDecoratorProps = Pick<
32
32
};
33
33
```
34
34
35
-
More info can be found [here](https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/orchestrator/plugins/orchestrator-form-api/src/api.ts).
35
+
More info can be found [here](../plugins/orchestrator-form-api/src/api.ts).
36
36
37
37
### Access to actual schema or form data by custom widgets
The most simple implementation of the API is the default one - adds no extra logic except passing the `formContext`.
57
-
See [its sources](https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/orchestrator/plugins/orchestrator-form-api/src/DefaultFormApi.tsx).
57
+
See [its sources](../plugins/orchestrator-form-api/src/DefaultFormApi.tsx).
58
58
59
-
More complex example is [the FormWidgetsApi provided by orchestrator-form-widgets plugin](https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/orchestrator/plugins/orchestrator-form-widgets/src/FormWidgetsApi.tsx).
59
+
More complex example is [the FormWidgetsApi provided by orchestrator-form-widgets plugin](../plugins/orchestrator-form-widgets/src/FormWidgetsApi.tsx).
For a schema example referencing custom `ui:widgets`, look [here](https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/orchestrator/plugins/orchestrator-form-widgets/http-workflow-dev-server/exampleWorkflows/schemas/dynamic-course-select__main-schema.json)
81
-
82
-
Instructions how to set the whole environment to run that example workflow, are listed [here](https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/orchestrator/plugins/orchestrator-form-widgets/README.md).
80
+
For a schema example referencing custom `ui:widgets`, look [here](https://github.com/rhdhorchestrator/backstage-orchestrator-workflows/blob/main/workflows/schemas/dynamic_schema__main-schema.json)
See `scalprum` config in the [package.json](https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/orchestrator/plugins/orchestrator-form-widgets/package.json).
93
+
See `scalprum` config in the [package.json](../plugins/orchestrator-form-widgets/package.json).
96
94
97
95
### Referencing the custom behavior in the schema
98
96
@@ -112,10 +110,6 @@ The `orchestrator-form-react` plugin handles the following key tasks:
112
110
113
111
- **Organizing Forms into Wizard-Style Steps:** If the schema is an object containing nested objects (i.e., the root is an object, and its properties are also objects), the plugin organizes the form into multiple steps. Each nested object becomes a separate step in a wizard-style interface. For example, the schema provided above results in two steps: _Personal Details_ and _Contact Details_.
114
112
115
-
The [`orchestrator-form-react`](https://github.com/janus-idp/backstage-plugins/tree/main/plugins/orchestrator-form-react) plugin is designed to operate independently of the main orchestrator plugin. This modularity allows developers to test and validate form behavior in a standalone Backstage development environment before integrating it with the full orchestrator setup.
113
+
The [`orchestrator-form-react`](../plugins/orchestrator-form-react) plugin is designed to operate independently of the main orchestrator plugin. This modularity allows developers to test and validate form behavior in a standalone Backstage development environment before integrating it with the full orchestrator setup.
116
114
117
115
To use this plugin, add the `@red-hat-developer-hub/backstage-plugin-orchestrator-form-react` package as a dependency in your project.
118
-
119
-
## Example implementation
120
-
121
-
Example implementation of the API is the [orchestrator-form-widgets](https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/orchestrator/plugins/orchestrator-form-widgets) which documentation can be found in [extensibleForm.md](./extensibleForm).
Copy file name to clipboardExpand all lines: workspaces/orchestrator/plugins/orchestrator-form-react/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,4 +2,4 @@
2
2
3
3
This library provides the form component used in the workflow execution form. It is decoupled from the orchestrator plugin to allow plugins implementing the OrchestratorFormApi test the behavior in a simple backstage developer environment.
4
4
5
-
Details available [here](../orchestrator/docs/extensibleForm.md).
5
+
Details available [here](../../docs/extensibleForm.md).
Copy file name to clipboardExpand all lines: workspaces/orchestrator/plugins/orchestrator-form-widgets/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# orchestrator-form-widgets
2
2
3
-
This Backstage frontend plugin provides default, but optional, set of RJSF form widgets for the Orchestrator workflow execution page as described in [orchestrator-form-api plugin](../orchestrator-form-api/README.md) or [extensibleForm.md](https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/orchestrator/docs/extensibleForm.md).
3
+
This Backstage frontend plugin provides default, but optional, set of RJSF form widgets for the Orchestrator workflow execution page as described in [extensibleForm.md](../../docs/extensibleForm.md).
4
4
5
-
Documentation of implemented widgets can be found in a [orchestratorFormWidgets.md](https://github.com/redhat-developer/rhdh-plugins/blob/main/workspaces/orchestrator/docs/orchestratorFormWidgets.md).
5
+
Documentation of implemented widgets can be found in a [orchestratorFormWidgets.md](../../docs/orchestratorFormWidgets.md).
0 commit comments