Skip to content

Commit ed8871f

Browse files
authored
Merge pull request #13 from robbat2/yarn-add
doc: fix yarn syntax - cwd must be first
2 parents 62aed4d + 41a020e commit ed8871f

6 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/advanced/create-service-software-template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ By doing so, it enables and configures the PagerDuty Card provided by the fronte
1212
If you were already using the scaffolder actions before this, follow the migration guide [here](/backstage-plugin-docs/advanced/backend-system-migration) as you need to update the package used in the code.
1313

1414
```bash
15-
yarn add --cwd packages/backend @pagerduty/backstage-plugin-scaffolder-actions # (1)!
15+
yarn --cwd packages/backend add @pagerduty/backstage-plugin-scaffolder-actions # (1)!
1616
```
1717

1818
1. This command adds `@pagerduty/backstage-plugin-scaffolder` package to the `packages/backend` folder because it is a backend module.
@@ -137,7 +137,7 @@ Once all the information is provided by the user we will:
137137
The UI component that allows users to select the *Escalation Policy* when creating a new service in PagerDuty depends on an open source component. For the template to work properly please install it before.
138138

139139
```bash
140-
yarn add --cwd packages/app @roadiehq/plugin-scaffolder-frontend-module-http-request-field
140+
yarn --cwd packages/app add @roadiehq/plugin-scaffolder-frontend-module-http-request-field
141141
```
142142

143143
Once it is installed, go to `/packages/app/src/App.tsx` and find `<ScaffolderPage />`. Add the UI component to `ScaffolderFieldExtensions`. It should look like this when you finish.

docs/advanced/service-entity-mapping.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ For that reason we create a `PagerDutyPage` component that is intended to be the
1313
In order to set this up in your Backstage instance you should install the necessary packages first by running the following command. This command will install the entity processor module that we will configure later on.
1414

1515
```bash
16-
yarn add --cwd packages/backend @pagerduty/backstage-plugin-entity-processor
16+
yarn --cwd packages/backend add @pagerduty/backstage-plugin-entity-processor
1717
```
1818

1919
!!! note

docs/getting-started/backstage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111
To install the PagerDuty plugin into Backstage run the following commands from your Backstage root directory.
1212

1313
```bash
14-
yarn add --cwd packages/app @pagerduty/backstage-plugin # (1)!
14+
yarn --cwd packages/app add @pagerduty/backstage-plugin # (1)!
1515
```
1616

1717
1. This command adds `@pagerduty/backstage-plugin` package to the `packages/app` folder because it is a frontend plugin.
1818

1919
```bash
20-
yarn add --cwd packages/backend @pagerduty/backstage-plugin-backend # (1)!
20+
yarn --cwd packages/backend add @pagerduty/backstage-plugin-backend # (1)!
2121
```
2222

2323
1. This command adds `@pagerduty/backstage-plugin-backend` package to the `packages/backend` folder because it is a backend plugin.

docs/migration/from-backstage-owned.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ If you are migrating from the PagerDuty plugin that was maintained by Backstage
1313

1414
```bash
1515
# From your Backstage root directory
16-
yarn add --cwd packages/app @pagerduty/backstage-plugin @pagerduty/backstage-plugin-common
16+
yarn --cwd packages/app add @pagerduty/backstage-plugin @pagerduty/backstage-plugin-common
1717
```
1818

1919
3. Replace all occurrences of `@backstage/plugin-pagerduty` with `@pagerduty/backstage-plugin` in your components
2020

2121
4. Install the backend PagerDuty plugin for Backstage
2222

2323
```bash
24-
yarn add --cwd packages/backend @pagerduty/backstage-plugin-backend @pagerduty/backstage-plugin-common
24+
yarn --cwd packages/backend add @pagerduty/backstage-plugin-backend @pagerduty/backstage-plugin-common
2525
```
2626

2727
5. [Add the backend plugin](/backstage-plugin-docs/getting-started/backstage/#add-the-backend-plugin-to-your-application) to your Backstage project

docs/release-notes/backend.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ This release adds support to the new [Backstage backend system](https://backstag
193193
1. Install new package
194194

195195
```bash
196-
yarn add --cwd packages/backend @pagerduty/backstage-plugin-scaffolder-actions
196+
yarn --cwd packages/backend add @pagerduty/backstage-plugin-scaffolder-actions
197197
yarn install
198198
```
199199

@@ -220,14 +220,14 @@ This release adds support to the new [Backstage backend system](https://backstag
220220
1. Install new package
221221
222222
```bash
223-
yarn add --cwd packages/backend @pagerduty/backstage-plugin-scaffolder-actions
223+
yarn --cwd packages/backend add @pagerduty/backstage-plugin-scaffolder-actions
224224
yarn install
225225
```
226226
227227
2. **(Optional)** If this is the first time configuring PagerDuty's plugin you also need the following packages
228228
229229
```bash
230-
yarn add --cwd packages/backend @pagerduty/backstage-plugin-backend @pagerduty/backstage-plugin-common
230+
yarn --cwd packages/backend add @pagerduty/backstage-plugin-backend @pagerduty/backstage-plugin-common
231231
yarn install
232232
```
233233

docs/release-notes/scaffolder-actions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ By adding support for the new backend system, we were forced to isolate the exis
7171
1. Install new package
7272

7373
```bash
74-
yarn add --cwd packages/backend @pagerduty/backstage-plugin-scaffolder-actions
74+
yarn --cwd packages/backend add @pagerduty/backstage-plugin-scaffolder-actions
7575
yarn install
7676
```
7777

@@ -98,14 +98,14 @@ By adding support for the new backend system, we were forced to isolate the exis
9898
1. Install new package
9999
100100
```bash
101-
yarn add --cwd packages/backend @pagerduty/backstage-plugin-scaffolder-actions
101+
yarn --cwd packages/backend add @pagerduty/backstage-plugin-scaffolder-actions
102102
yarn install
103103
```
104104
105105
2. **(Optional)** If this is the first time configuring PagerDuty's plugin you also need the following packages
106106
107107
```bash
108-
yarn add --cwd packages/backend @pagerduty/backstage-plugin-backend @pagerduty/backstage-plugin-common
108+
yarn --cwd packages/backend add @pagerduty/backstage-plugin-backend @pagerduty/backstage-plugin-common
109109
yarn install
110110
```
111111

0 commit comments

Comments
 (0)