Skip to content

Commit 30a57a0

Browse files
authored
docs(orchestrator): fix broken links, and make in repo links relative (#1407)
1 parent 617de8b commit 30a57a0

File tree

3 files changed

+10
-16
lines changed

3 files changed

+10
-16
lines changed

workspaces/orchestrator/docs/extensibleForm.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This decorator supports overriding a selected set of [react-json-schema-form pro
1313
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.
1414
To trigger the desired behavior, the workflow schema should include custom UI properties.
1515

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).
1717

1818
## API
1919

@@ -32,7 +32,7 @@ export type FormDecoratorProps = Pick<
3232
};
3333
```
3434

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).
3636

3737
### Access to actual schema or form data by custom widgets
3838

@@ -54,9 +54,9 @@ export const SchemaUpdater: Widget<
5454
### Example API Implementation
5555

5656
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).
5858

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).
6060

6161
### Plugin Creation Example
6262

@@ -77,9 +77,7 @@ export const testFactoryPlugin = createPlugin({
7777

7878
### Schema example
7979

80-
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)
8381

8482
### Dynamic plugin configuration
8583

@@ -92,7 +90,7 @@ pluginConfig:
9290
red-hat-developer-hub.backstage-plugin-orchestrator-form-widgets: {}
9391
```
9492
95-
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).
9694

9795
### Referencing the custom behavior in the schema
9896

@@ -112,10 +110,6 @@ The `orchestrator-form-react` plugin handles the following key tasks:
112110

113111
- **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_.
114112

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.
116114

117115
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).

workspaces/orchestrator/plugins/orchestrator-form-react/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
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.
44

5-
Details available [here](../orchestrator/docs/extensibleForm.md).
5+
Details available [here](../../docs/extensibleForm.md).

workspaces/orchestrator/plugins/orchestrator-form-widgets/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# orchestrator-form-widgets
22

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).
44

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).
66

77
## Deployment
88

0 commit comments

Comments
 (0)