From 753b811d402e540058f97a74c6d63747d815b3e4 Mon Sep 17 00:00:00 2001 From: Michael Smith Date: Mon, 15 Apr 2024 17:09:23 -0400 Subject: [PATCH 1/2] fix: update confusing example in Coder plugin README --- plugins/backstage-plugin-coder/README.md | 27 ++++++++++++++++++------ 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/plugins/backstage-plugin-coder/README.md b/plugins/backstage-plugin-coder/README.md index eb53cb29..fffb1f79 100644 --- a/plugins/backstage-plugin-coder/README.md +++ b/plugins/backstage-plugin-coder/README.md @@ -47,7 +47,8 @@ the Dev Container. 3. Add the `CoderProvider` to the application: ```tsx - // In packages/app/src/App.tsx + // packages/app/src/App.tsx + import { type CoderAppConfig, CoderProvider, @@ -94,14 +95,26 @@ the Dev Container. 4. Add the `CoderWorkspacesCard` card to the entity page in your app: ```tsx - // In packages/app/src/components/catalog/EntityPage.tsx + // packages/app/src/components/catalog/EntityPage.tsx + import { CoderWorkspacesCard } from '@coder/backstage-plugin-coder'; - // ... - - - - ; + // We recommend placing the component inside of overviewContent + const overviewContent = ( + + {entityWarningContent} + + + + + {/* Coder component should go inside Grid to help it work with MUI layouts */} + + + + + {/* Other elements for overviewContent go here */} + + ); ``` ### `app-config.yaml` files From 7c5d1acf472c8ca1b0e3b063ec68682ff4350d2a Mon Sep 17 00:00:00 2001 From: Parkreiner Date: Mon, 15 Apr 2024 21:14:15 +0000 Subject: [PATCH 2/2] fix: remove accidental whitespace --- plugins/backstage-plugin-coder/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/plugins/backstage-plugin-coder/README.md b/plugins/backstage-plugin-coder/README.md index fffb1f79..657521e2 100644 --- a/plugins/backstage-plugin-coder/README.md +++ b/plugins/backstage-plugin-coder/README.md @@ -48,7 +48,7 @@ the Dev Container. ```tsx // packages/app/src/App.tsx - + import { type CoderAppConfig, CoderProvider, @@ -96,7 +96,7 @@ the Dev Container. ```tsx // packages/app/src/components/catalog/EntityPage.tsx - + import { CoderWorkspacesCard } from '@coder/backstage-plugin-coder'; // We recommend placing the component inside of overviewContent @@ -111,7 +111,7 @@ the Dev Container. - + {/* Other elements for overviewContent go here */} );