Chore: fix example entityPage and add env details to readme (#82)

* fix example entityPage and add env details to readme
env0 · Jan 7, 2025 · 10065fc · 10065fc
1 parent 1ee3008
commit 10065fc
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 5 deletions.
diff --git a/packages/app/src/components/catalog/EntityPage.tsx b/packages/app/src/components/catalog/EntityPage.tsx
@@ -134,7 +134,11 @@ const entityWarningContent = (
 const overviewContent = (
   <>
     {entityWarningContent}
-    <Env0EnvironmentDetailsCard />
+    <EntitySwitch>
+      <EntitySwitch.Case if={entity => isEnv0Available(entity)}>
+        <Env0EnvironmentDetailsCard />
+      </EntitySwitch.Case>
+    </EntitySwitch>
   </>
 );
 

diff --git a/plugins/backstage-plugin-env0/README.md b/plugins/backstage-plugin-env0/README.md
@@ -25,9 +25,9 @@ yarn --cwd packages/app add @env0/backstage-plugin-env0
 ```tsx
 // In packages/app/src/components/catalog/EntityPage.tsx
 import {
-  env0TabComponent,
-  isenv0Available,
-  env0EnvironmentDetailsCard,
+  Env0TabComponent,
+  isEnv0Available,
+  Env0EnvironmentDetailsCard,
 } from '@env0/backstage-plugin-env0';
 ```
 
@@ -42,7 +42,18 @@ import {
   <Env0TabComponent />
 </EntityLayout.Route>
 ```
-### 3. Provide the env0 proxy configuration in `app-config.yaml`:
+
+### 3. Add the env0 details component to `EntityPage.tsx`:
+#### Add the env0 details component to the `overviewPage` constant:
+```tsx
+// In packages/app/src/components/catalog/EntityPage.tsx
+<EntitySwitch>
+  <EntitySwitch.Case if={entity => isEnv0Available(entity)}>
+    <Env0EnvironmentDetailsCard />
+  </EntitySwitch.Case>
+</EntitySwitch>
+```
+### 4. Provide the env0 proxy configuration in `app-config.yaml`:
 ```yaml
 proxy:
   '/env0':