docs(dynamic-plugins): update todo plugin instructions and add TypeSc…

…ript compilation step (#2182) Signed-off-by: Marcel Hild <hild@b4mad.net> Co-authored-by: Tomas Kral <tkral@redhat.com>
redhat-developer · Jan 24, 2025 · 2ff6fd2 · 2ff6fd2
1 parent fa2e216
commit 2ff6fd2
Showing 1 changed file with 18 additions and 17 deletions.
diff --git a/docs/dynamic-plugins/index.md b/docs/dynamic-plugins/index.md
@@ -45,14 +45,15 @@ Example of this process on the [todo](https://github.com/backstage/community-plu
     $ git clone https://github.com/backstage/community-plugins
     $ cd community-plugins/workspaces/todo
     $ yarn install
+    $ yarn tsc
     ```
 
 2. Export the backend and frontend plugins
 
     Export backend plugin.
 
     ```console
-    $ cd todo-backend
+    $ cd plugins/todo-backend
     $ npx @janus-idp/cli@latest package export-dynamic-plugin
     Building main package
       executing     yarn build ✔
@@ -148,22 +149,22 @@ Example of this process on the [todo](https://github.com/backstage/community-plu
     Add plugins defintion to the `dynamic-plugins.yaml` file.
 
     ```yaml
-    # dynamic-plugins.yaml
-    packages:
-     - package: oci://quay.io/tkral/backstage-community-plugin-todo:v0.1.1!backstage-community-plugin-todo
-       pluginConfig:
-         dynamicPlugins:
-           frontend:
-             backstage-community.plugin-todo:
-               mountPoints:
-                 - mountPoint: entity.page.todo/cards
-                   importName: EntityTodoContent
-               entityTabs:
-                 - path: /todo
-                   title: Todo
-                   mountPoint: entity.page.todo
-     - package: oci://quay.io/tkral/backstage-community-plugin-todo:v0.1.1!backstage-community-plugin-todo-backend-dynamic
-       disabled: false
+    # frontend and backend plugins for the todo plugin
+    - package: oci://quay.io/user/backstage-community-plugin-todo:v0.1.1!backstage-community-plugin-todo
+      disabled: false
+      pluginConfig:
+        dynamicPlugins:
+          frontend:
+            backstage-community.plugin-todo:
+              mountPoints:
+                - mountPoint: entity.page.todo/cards
+                  importName: EntityTodoContent
+              entityTabs:
+                - path: /todo
+                  title: Todo
+                  mountPoint: entity.page.todo
+    - package: oci://quay.io/user/backstage-community-plugin-todo:v0.1.1!backstage-community-plugin-todo-backend-dynamic
+      disabled: false
     ```