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

Parkreiner · web-flow · commit 41169a972c90 · 2024-03-26T23:08:40.000-04:00
* docs: add clarifying text to backend README

* docs: fix formatting issue
diff --git a/plugins/backstage-plugin-devcontainers-backend/README.md b/plugins/backstage-plugin-devcontainers-backend/README.md
@@ -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:
@@ -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
@@ -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,
