Skip to content

Commit

Permalink
docs(setup): Usage Error: The --cwd option is ambiguous (#419)
Browse files Browse the repository at this point in the history
* docs(setup): Usage Error: The --cwd option is ambiguous

When following the setup instructions, the following error occurs:

```
Usage Error: The --cwd option is ambiguous when used anywhere else than the very first parameter provided in the command line, before even the command path
```

Signed-off-by: Mark Shields <[email protected]>

* fix other docs yarn add/cwd order

Signed-off-by: Mark Shields <[email protected]>

---------

Signed-off-by: Mark Shields <[email protected]>
  • Loading branch information
beejiujitsu committed Sep 10, 2024
1 parent 5a7c10a commit ccdcb29
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Add the plugin to your backend app:

```bash
yarn add --cwd packages/backend @procore-oss/backstage-plugin-announcements-backend
yarn --cwd packages/backend add @procore-oss/backstage-plugin-announcements-backend
```

Create `packages/backend/src/plugins/announcements.ts`:
Expand Down Expand Up @@ -73,7 +73,7 @@ async function main() {
Add the plugin to your backend app:

```bash
yarn add --cwd packages/backend @procore-oss/backstage-plugin-announcements-backend
yarn --cwd packages/backend add @procore-oss/backstage-plugin-announcements-backend
```

Update `packages/backend/src/index.ts` to import announcements plugin package and register it in your backend using:
Expand All @@ -91,7 +91,7 @@ backend.add(import('@procore-oss/backstage-plugin-announcements-backend'));
Add the plugin to your frontend app:

```bash
yarn add --cwd packages/app @procore-oss/backstage-plugin-announcements
yarn --cwd packages/app add @procore-oss/backstage-plugin-announcements
```

Expose the announcements page:
Expand All @@ -118,7 +118,7 @@ An interface to create/update/edit/delete announcements is now available at `/an
Add the plugin to your frontend app:

```bash
yarn add --cwd packages/app @procore-oss/backstage-plugin-announcements
yarn --cwd packages/app add @procore-oss/backstage-plugin-announcements
```

Add the plugin to `packages/app/src/App.tsx`:
Expand Down

0 comments on commit ccdcb29

Please sign in to comment.