Skip to content

Commit a363b7b

Browse files
committed
Renumber merged steps to sequential order
- create-backend-plugin: 'Steps 2-3' -> Step 2, renumber 4-6 to 3-5 - enable-plugin workflow: 'Steps 1-3' -> Step 1, renumber 4-8 to 2-6 - create-frontend-plugin: clean up 'Steps 2 + 4' reference in notes
1 parent b99115f commit a363b7b

3 files changed

Lines changed: 17 additions & 18 deletions

File tree

skills/create-backend-plugin/SKILL.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,18 @@ Before starting, ensure the following are available:
3737
## Workflow Overview
3838

3939
1. **Determine RHDH Version** - Identify target RHDH version for compatibility
40-
2. **Create Backstage App** - Scaffold Backstage app with matching version
41-
3. **Create Backend Plugin** - Generate new backend plugin using Backstage CLI
42-
4. **Implement Plugin Logic** - Write the plugin code using new backend system
43-
5. **Export and Package** - Build, export, and package using RHDH CLI (see export-and-package skill)
44-
6. **Configure for RHDH** - Create dynamic-plugins.yaml configuration
40+
2. **Scaffold App and Plugin** - Create Backstage app and generate backend plugin
41+
3. **Implement Plugin Logic** - Write the plugin code using new backend system
42+
4. **Export and Package** - Build, export, and package using RHDH CLI (see export-and-package skill)
43+
5. **Configure for RHDH** - Create dynamic-plugins.yaml configuration
4544

4645
## Step 1: Determine RHDH Version
4746

4847
Check the target RHDH version and find the compatible Backstage version. Consult `../rhdh/references/versions.md` file for the version compatibility matrix and available RHDH versions.
4948

5049
Ask the user which RHDH version they are targeting if not specified.
5150

52-
## Steps 2-3: Create Backstage Application & Backend Plugin
51+
## Step 2: Scaffold App and Plugin
5352

5453
Use the scaffold script to automate app creation, dependency installation, and plugin generation in one command:
5554

@@ -97,7 +96,7 @@ plugins/<plugin-id>-backend/
9796
└── README.md
9897
```
9998

100-
## Step 4: Implement Plugin Logic
99+
## Step 3: Implement Plugin Logic
101100

102101
Backend plugins must use the **new backend system** for dynamic plugin compatibility. The plugin entry point should export a default using `createBackendPlugin()` or `createBackendModule()`.
103102

@@ -151,7 +150,7 @@ cd plugins/<plugin-id>-backend
151150
yarn build
152151
```
153152

154-
## Step 5: Export and Package
153+
## Step 4: Export and Package
155154

156155
Export the plugin as a dynamic plugin and package it for deployment. For detailed export and packaging options, see the **export-and-package** skill.
157156

@@ -175,7 +174,7 @@ podman push quay.io/<namespace>/<plugin-name>:v0.1.0
175174

176175
For advanced options (dependency handling, multi-plugin bundles, tgz/npm packaging), consult the **export-and-package** skill.
177176

178-
## Step 6: Configure for RHDH
177+
## Step 5: Configure for RHDH
179178

180179
Create the dynamic plugin configuration for RHDH. Add to `dynamic-plugins.yaml`:
181180

skills/create-frontend-plugin/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Ask the user which RHDH version they are targeting if not specified.
5656

5757
## Step 2: Create Backstage Application
5858

59-
> **Automated:** Steps 2 + 4 (and optionally 3) are automated by the scaffold script.
59+
> **Automated:** This step plus Step 4 (and optionally Step 3) are automated by the scaffold script.
6060
> Run it from the directory where the app should be created:
6161
>
6262
> ```bash
@@ -110,7 +110,7 @@ const app = createApp({
110110

111111
## Step 4: Create Frontend Dynamic Plugin
112112

113-
> **Automated:** If you used `scripts/scaffold.py` in Step 2, this step was already completed. Skip to Step 5.
113+
> **Automated:** If you used the scaffold script in Step 2, this step was already completed. Skip to Step 5.
114114
115115
### Manual method
116116

skills/rhdh-local/workflows/enable-plugin.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Read before starting:
1212

1313
> **Note:** This sequence involves multiple API calls to GitHub. If any step fails, check GitHub API rate limits and authentication.
1414
15-
## Steps 1–3: Identify Plugin & Fetch Metadata
15+
## Step 1: Identify Plugin & Fetch Metadata
1616

1717
Ask the user which plugin to enable. Use the `fetch-plugin-metadata.py` script to list plugins and retrieve all metadata in one step:
1818

@@ -81,7 +81,7 @@ Extract: `spec.dynamicArtifact`, `spec.backstage.role`, `spec.appConfigExamples`
8181

8282
---
8383

84-
## Step 4: Add to `dynamic-plugins.override.yaml`
84+
## Step 2: Add to `dynamic-plugins.override.yaml`
8585

8686
Edit `rhdh-customizations/configs/dynamic-plugins/dynamic-plugins.override.yaml`.
8787

@@ -130,7 +130,7 @@ Backend plugins should be listed before their corresponding frontend plugins.
130130

131131
---
132132

133-
## Step 5: Add Backend Configuration (if needed)
133+
## Step 3: Add Backend Configuration (if needed)
134134

135135
If `spec.appConfigExamples` includes configuration outside the `dynamicPlugins` key, add it to:
136136
`rhdh-customizations/configs/app-config/app-config.local.yaml`
@@ -150,7 +150,7 @@ argocd:
150150

151151
---
152152

153-
## Step 6: Set Required Environment Variables
153+
## Step 4: Set Required Environment Variables
154154

155155
If backend config references `${VAR_NAME}` variables, tell the user to add them to `rhdh-customizations/.env` (bare format — no `export`, no quotes):
156156

@@ -163,18 +163,18 @@ This file overrides `rhdh-local/default.env`.
163163

164164
---
165165

166-
## Step 7: Present Summary
166+
## Step 5: Present Summary
167167

168168
Before applying, show the user:
169169

170170
- Which packages were added to `dynamic-plugins.override.yaml`
171171
- What app-config was added (if any)
172172
- What environment variables need to be set in `.env`
173-
- The commands from Step 8
173+
- The commands from Step 6
174174

175175
---
176176

177-
## Step 8: Apply and Restart
177+
## Step 6: Apply and Restart
178178

179179
```bash
180180
rhdh local apply

0 commit comments

Comments
 (0)