docs(orchestrator): add info on specific form packages for 1.3 (#2542)

docs(orchestrator): add info on package and example versions compatible with 1.3
janus-idp · Nov 18, 2024 · fbf72ff · fbf72ff
1 parent a2abe1c
commit fbf72ff
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/.changeset/purple-terms-pretend.md b/.changeset/purple-terms-pretend.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/plugins/orchestrator/docs/extensibleForm.md b/plugins/orchestrator/docs/extensibleForm.md
@@ -10,11 +10,17 @@ This capability enables developers to extend and customize the `react-jsonschema
 
 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. To trigger the desired behavior, the workflow schema should include custom UI properties.
 
-For reference, an example plugin can be found [here](https://github.com/parodos-dev/custom-form-example-plugin).
+For reference, an example plugin can be found [here](https://github.com/parodos-dev/custom-form-example-plugin/tree/1.3).
 
 ## 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
@@ -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.