Skip to content

docs(devcontainers-backend): add clarifying text to README #87

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 3 commits into from
Mar 27, 2024
Merged

docs(devcontainers-backend): add clarifying text to README #87

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
544c534
docs: add clarifying text to backend README
Parkreiner Mar 25, 2024
5fee40d
docs: fix formatting issue
Parkreiner Mar 25, 2024
58b299b
Merge branch 'main' into mes/backend-docs
Parkreiner Mar 27, 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
8 changes: 7 additions & 1 deletion plugins/backstage-plugin-devcontainers-backend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ _Note: While this plugin can be used standalone, it has been designed to be a ba

## Setup

> [!WARNING]
> All setup instructions assume you are using a Backstage deployment created with `@backstage/create-app` version `0.5.10` or earlier. Any later versions may or may not use Backstage's New Backend System (described [here](https://backstage.io/docs/backend-system/) and [here](https://backstage.io/docs/plugins/new-backend-system/)). We are currently evaluating how best to support the new system.

### Before you begin

Ensure that you have the following ready to go:
Expand All @@ -36,7 +39,7 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins
```shell
yarn --cwd packages/backend add @coder/backstage-plugin-devcontainers-backend
```
2. Navigate to the `backend` directory's `catalog.ts` file
2. Navigate to the `backend/src/plugins/catalog.ts` file (this file should automatically be created for you through `@backstage/create-app`)
3. Import your source control manager provider of choice (Backstage has built-in support for GitHub, GitLab, and Bitbucket)

```ts
Expand Down Expand Up @@ -105,7 +108,10 @@ export default async function createPlugin(
}),
);

// ScaffolderEntitiesProcessor is one of the processors automatically
// added to a newly-scaffolded application
builder.addProcessor(new ScaffolderEntitiesProcessor());

builder.addProcessor(
DevcontainersProcessor.fromConfig(env.config, {
logger: env.logger,
Expand Down