Skip to content

Commit

Permalink
docs(orchestrator): add info on specific form packages for 1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
batzionb committed Nov 18, 2024
1 parent a2abe1c commit a57056f
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions plugins/orchestrator/docs/extensibleForm.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,13 @@ For reference, an example plugin can be found [here](https://github.com/parodos-

## API

To implement the API, include @janus-idp/backstage-plugin-orchestrator-form-api package as a dependency.
To implement the API, include @janus-idp/backstage-plugin-orchestrator-form-api package as a dependency by running:

```bash
yarn add @janus-idp/backstage-plugin-orchestrator-form-api@~1.0.101
```
This will ensure that you install version 1.0.101 of the package that is compatible with backstage 1.29.x, allowing updates only to patch versions within the 1.0.x range.

This package provides the `FormExtensionsApi` interface and related types.

```typescript
Expand Down Expand Up @@ -133,4 +139,9 @@ The `orchestrator-form-react` plugin handles the following key tasks:

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.

To use this plugin, add the `@janus-idp/backstage-plugin-orchestrator-form-react` package as a dependency in your project.
To use orchestrator-form-react, add the `@janus-idp/backstage-plugin-orchestrator-form-react` package as a dependency in your project by running:

```bash
yarn add @janus-idp/backstage-plugin-orchestrator-form-react@~1.0.101
```
This will ensure that you install version 1.0.101 of the package that is compatible with backstage 1.29.x, allowing updates only to patch versions within the 1.0.x range.

0 comments on commit a57056f

Please sign in to comment.