You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
# Backstage Plugins
2
2
3
-
A collection of plugins that extend [Backstage](https://backstage.io) to help with developer onboarding, context switching, and inner loop software development.
3
+
A collection of plugins that extend [Backstage](https://backstage.io) to help with developer onboarding, context switching, and automated IDE environments (remote or local).
4
4
5
5
-[backstage-plugin-coder](./plugins/backstage-plugin-coder/README.md): A plugin for integrating Coder workspaces with Backstage.
6
-
-[backstage-plugin-devcontainers](./plugins/backstage-plugin-devcontainers/README.md): A plugin for integrating VS Code Dev Containers extension with Backstage catalog items (no Coder deployment necessary).
6
+
-[backstage-plugin-devcontainers-backend](./plugins/backstage-plugin-devcontainers/README.md): A plugin for integrating VS Code Dev Containers extension with Backstage catalog items (no Coder deployment necessary).
7
7
8
8
Please use [GitHub issues](https://github.com/coder/backstage-plugins/issues) to report any issues or feature requests.
@@ -13,7 +15,7 @@ Create and manage [Coder workspaces](https://coder.com/docs/v2/latest) from Back
13
15
- Users link their Coder accounts with Backstage via tokens
14
16
- Associate Coder workspaces with catalog items in Backstage
15
17
- Workspace list component for viewing and managing workspaces
16
-
-Full Coder API access for custom plugins & integrations
18
+
<!-- - Full Coder API access for custom plugins & integrations-->
17
19
18
20
## Setup
19
21
@@ -87,9 +89,9 @@ the devcontainer.
87
89
);
88
90
```
89
91
90
-
> Note: You can also wrap a single page or component with `CoderProvider` if you only need Coder in a specific part of your app. See our [API reference](#TODO) for more details.
92
+
<!-- > Note: You can also wrap a single page or component with `CoderProvider` if you only need Coder in a specific part of your app. See our [API reference](#TODO) for more details. -->
91
93
92
-
1. Add the `WorkspacesList` card to the entity page in your app:
94
+
1. Add the `CoderWorkspacesCard` card to the entity page in your app:
93
95
94
96
```tsx
95
97
// In packages/app/src/components/catalog/EntityPage.tsx
@@ -102,9 +104,9 @@ the devcontainer.
102
104
</Grid>;
103
105
```
104
106
105
-
See [the plugin documentation](./docs) for full configuration options and API reference.
107
+
<!-- Individual components of the card can also be imported. See [the plugin documentation](./docs) for full configuration options and API reference. -->
106
108
107
-
### API Access
109
+
<!-- ### API Access
108
110
109
111
The plugin provides a `CoderApi` instance for accessing the Coder API. This can be used in custom plugins and integrations. Here is an example component that lists all templates:
110
112
@@ -117,7 +119,7 @@ import { useCoder } from '@coder/backstage-plugin-coder';
117
119
// with a refresh button
118
120
```
119
121
120
-
See to the [Coder REST API Reference](https://coder.com/docs/v2/latest/api) for more details
122
+
See to the [Coder REST API Reference](https://coder.com/docs/v2/latest/api) for more details -->
0 commit comments