Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix: update confusing example in Coder plugin README #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 15, 2024
Merged

fix: update confusing example in Coder plugin README #115

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
753b811
fix: update confusing example in Coder plugin README
Parkreiner Apr 15, 2024
7c5d1ac
fix: remove accidental whitespace
Parkreiner Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions plugins/backstage-plugin-coder/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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
import { CoderWorkspacesCard } from '@coder/backstage-plugin-coder';
// packages/app/src/components/catalog/EntityPage.tsx

// ...
import { CoderWorkspacesCard } from '@coder/backstage-plugin-coder';

<Grid item md={6} xs={12}>
<CoderWorkspacesCard readEntityData />
</Grid>;
// We recommend placing the component inside of overviewContent
const overviewContent = (
<Grid container spacing={3} alignItems="stretch">
{entityWarningContent}
<Grid item md={6}>
<EntityAboutCard variant="gridItem" />
</Grid>

{/* Coder component should go inside Grid to help it work with MUI layouts */}
<Grid item md={6} xs={12}>
<CoderWorkspacesCard readEntityData />
</Grid>

{/* Other elements for overviewContent go here */}
</Grid>
);
```

### `app-config.yaml` files
Expand Down