Merge pull request #10528 from LvffY/master

Update documentation

plugins/airbrake/README.md

@@ -8,16 +8,14 @@ The Airbrake plugin provides connectivity between Backstage and Airbrake (https:
 
    ```bash
    # From your Backstage root directory
-   cd packages/app
-   yarn add @backstage/plugin-airbrake
+   yarn add --cwd packages/app @backstage/plugin-airbrake
    ```
 
 2. Install the Backend plugin:
 
    ```bash
    # From your Backstage root directory
-   cd packages/backend
-   yarn add @backstage/plugin-airbrake-backend
+   yarn add --cwd packages/backend @backstage/plugin-airbrake-backend
    ```
 
 3. Add the `EntityAirbrakeContent` to `packages/app/src/components/catalog/EntityPage.tsx` for all the entity pages you want Airbrake to be in:

plugins/api-docs/README.md

@@ -29,8 +29,7 @@ To link that a component provides or consumes an API, see the [`providesApis`](h
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-api-docs
+yarn add --cwd packages/app @backstage/plugin-api-docs
 ```
 
 2. Add the `ApiExplorerPage` extension to the app:

plugins/app-backend/README.md

@@ -8,8 +8,7 @@ Add both this package and your local frontend app package as dependencies to you
 
 ```bash
 # From your Backstage root directory
-cd packages/backend
-yarn add @backstage/plugin-app-backend app
+yarn add --cwd packages/backend @backstage/plugin-app-backend app
 ```
 
 By adding the app package as a dependency we ensure that it is built as part of the backend, and that it can be resolved at runtime.

plugins/azure-devops/README.md

@@ -68,8 +68,7 @@ To get the Azure Pipelines component working you'll need to do the following two
 
    ```bash
    # From your Backstage root directory
-   cd packages/app
-   yarn add @backstage/plugin-azure-devops
+   yarn add --cwd packages/app @backstage/plugin-azure-devops
    ```
 
 2. Second we need to add the `EntityAzurePipelinesContent` extension to the entity page in your app. How to do this will depend on which annotation you are using in your entities:
@@ -127,8 +126,7 @@ To get the Azure Repos component working you'll need to do the following two ste
 
    ```bash
    # From your Backstage root directory
-   cd packages/app
-   yarn add @backstage/plugin-azure-devops
+   yarn add --cwd packages/app @backstage/plugin-azure-devops
    ```
 
 2. Second we need to add the `EntityAzurePullRequestsContent` extension to the entity page in your app:

plugins/bazaar-backend/README.md

@@ -8,8 +8,7 @@ Welcome to the Bazaar backend plugin!
 
 ```bash
 # From your Backstage root directory
-cd packages/backend
-yarn add @backstage/plugin-bazaar-backend
+yarn add --cwd packages/backend @backstage/plugin-bazaar-backend
 ```
 
 ## Adding the plugin to your `packages/backend`

plugins/bazaar/README.md

@@ -16,10 +16,9 @@ The Bazaar allows engineers and teams to open up and announce their new and exci
 
 First install the plugin into your app:
 
-```sh
+```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-bazaar
+yarn add --cwd packages/app @backstage/plugin-bazaar
 ```
 
 Modify your app routes in `packages/app/src/App.tsx` to include the `Bazaar` component exported from the plugin, for example:

plugins/bitrise/README.md

@@ -7,10 +7,9 @@ Welcome to the Bitrise plugin!
 
 ## Installation
 
-```sh
+```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-bitrise
+yarn add --cwd packages/app @backstage/plugin-bitrise
 ```
 
 Bitrise Plugin exposes an entity tab component named `EntityBitriseContent`. You can include it in the

plugins/catalog-backend-module-msgraph/README.md

@@ -84,8 +84,7 @@ By default, all users are loaded. If you want to filter users based on their att
 
 ```bash
 # From your Backstage root directory
-cd packages/backend
-yarn add @backstage/plugin-catalog-backend-module-msgraph
+yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-msgraph
 ```
 
 ### Using the Entity Provider

plugins/catalog-backend/README.md

@@ -27,8 +27,7 @@ restoring the plugin, if you previously removed it.
 
 ```bash
 # From your Backstage root directory
-cd packages/backend
-yarn add @backstage/plugin-catalog-backend
+yarn add --cwd packages/backend @backstage/plugin-catalog-backend
 ```
 
 ### Adding the plugin to your `packages/backend`

plugins/catalog-import/README.md

@@ -19,8 +19,7 @@ Some features are not yet available for all supported Git providers.
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-catalog-import
+yarn add --cwd packages/app @backstage/plugin-catalog-import
 ```
 
 2. Add the `CatalogImportPage` extension to the app:

plugins/catalog/README.md

@@ -20,8 +20,7 @@ plugin, if you previously removed it.
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-catalog
+yarn add --cwd packages/app @backstage/plugin-catalog
 ```
 
 ### Add the plugin to your `packages/app`

plugins/circleci/README.md

@@ -11,8 +11,7 @@ Website: [https://circleci.com/](https://circleci.com/)
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-circleci
+yarn add --cwd packages/app @backstage/plugin-circleci
 ```
 
 2. Add the `EntityCircleCIContent` extension to the entity page in your app:

plugins/code-climate/README.md

@@ -10,8 +10,7 @@ The Code Climate Plugin displays a few stats from the quality section from [Code
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-code-climate
+yarn add --cwd packages/app @backstage/plugin-code-climate
 ```
 
 2. Add the `EntityCodeClimateCard` to the EntityPage:

plugins/cost-insights/README.md

@@ -17,8 +17,7 @@ Learn more with the Backstage blog post [New Cost Insights plugin: The engineer'
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-cost-insights
+yarn add --cwd packages/app @backstage/plugin-cost-insights
 ```
 
 ## Setup

plugins/cost-insights/contrib/aws-cost-explorer-api.md

@@ -34,8 +34,7 @@ Install the AWS Cost Explorer SDK. The AWS docs recommend using the SDK over mak
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @aws-sdk/client-cost-explorer
+yarn add --cwd packages/app @aws-sdk/client-cost-explorer
 ```
 
 ## Usage of the SDK

plugins/firehydrant/README.md

@@ -18,8 +18,7 @@ The [FireHydrant](https://firehydrant.io) plugin brings incident management to B
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-firehydrant
+yarn add --cwd packages/app @backstage/plugin-firehydrant
 ```
 
 2. Add the plugin to `EntityPage.tsx`, inside the `const overviewContent`'s parent `<Grid>` component:

plugins/fossa/README.md

@@ -10,8 +10,7 @@ The FOSSA Plugin displays code statistics from [FOSSA](https://fossa.com/).
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-fossa
+yarn add --cwd packages/app @backstage/plugin-fossa
 ```
 
 2. Add the `EntityFossaCard` to the EntityPage:

plugins/github-actions/README.md

@@ -39,8 +39,7 @@ TBD
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-github-actions
+yarn add --cwd packages/app @backstage/plugin-github-actions
 ```
 
 2. Add to the app `EntityPage` component:

plugins/github-deployments/README.md

@@ -14,8 +14,7 @@ The GitHub Deployments Plugin displays recent deployments from GitHub.
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-github-deployments
+yarn add --cwd packages/app @backstage/plugin-github-deployments
 ```
 
 2. Add the `EntityGithubDeploymentsCard` to the EntityPage:

plugins/graphiql/README.md

@@ -13,8 +13,7 @@ Start out by installing the plugin in your Backstage app:
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-graphiql
+yarn add --cwd packages/app @backstage/plugin-graphiql
 ```
 
 ```diff

plugins/home/README.md

@@ -10,8 +10,7 @@ If you have a standalone app (you didn't clone this repo), then do
 
 ```bash
 # From the Backstage repository root
-cd packages/app
-yarn add @backstage/plugin-home
+yarn add --cwd packages/app @backstage/plugin-home
 ```
 
 ### Setting up the Home Page

plugins/ilert/README.md

@@ -27,8 +27,7 @@ Install the plugin:
 
 ```bash
 # From the Backstage repository root
-cd packages/app
-yarn add @backstage/plugin-ilert
+yarn add --cwd packages/app @backstage/plugin-ilert
 ```
 
 Add it to the `EntityPage.tsx`:

plugins/jenkins-backend/README.md

@@ -14,8 +14,7 @@ This plugin needs to be added to an existing backstage instance.
 
 ```bash
 # From your Backstage root directory
-cd packages/backend
-yarn add @backstage/plugin-jenkins-backend
+yarn add --cwd packages/backend @backstage/plugin-jenkins-backend
 ```
 
 Typically, this means creating a `src/plugins/jenkins.ts` file and adding a reference to it to `src/index.ts`

plugins/jenkins/README.md

@@ -12,8 +12,7 @@ Website: [https://jenkins.io/](https://jenkins.io/)
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-jenkins
+yarn add --cwd packages/app @backstage/plugin-jenkins
 ```
 
 2. Add and configure the [jenkins-backend](../jenkins-backend) plugin according to it's instructions

plugins/lighthouse/README.md

@@ -27,10 +27,9 @@ _It's likely you will need to [enable CORS](https://developer.mozilla.org/en-US/
 
 When you have an instance running that Backstage can hook into, first install the plugin into your app:
 
-```sh
+```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-lighthouse
+yarn add --cwd packages/app @backstage/plugin-lighthouse
 ```
 
 Modify your app routes in `App.tsx` to include the `LighthousePage` component exported from the plugin, for example:

plugins/pagerduty/README.md

@@ -42,8 +42,7 @@ First, install the PagerDuty plugin via a CLI:
 
 ```bash
 # From your Backstage app root directory
-cd packages/app
-yarn add @backstage/plugin-pagerduty
+yarn add --cwd packages/app @backstage/plugin-pagerduty
 ```
 
 Next, add the plugin to `EntityPage.tsx` in `packages/app/src/components/catalog` by adding the following code snippets.
@@ -133,8 +132,7 @@ pagerduty:
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn remove @backstage/plugin-pagerduty
+yarn remove --cwd packages/app @backstage/plugin-pagerduty
 ```
 
 4. [Delete the integration](https://support.pagerduty.com/docs/services-and-integrations#delete-an-integration-from-a-service) from the service in PagerDuty

plugins/periskop/README.md

@@ -19,8 +19,7 @@ Each of the entries in the table will direct you to the error details in your de
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-periskop
+yarn add --cwd packages/app @backstage/plugin-periskop
 ```
 
 3. Add to the app `EntityPage` component:

plugins/rollbar/README.md

@@ -10,8 +10,7 @@ Website: [https://rollbar.com/](https://rollbar.com/)
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-rollbar
+yarn add --cwd packages/app @backstage/plugin-rollbar
 ```
 
 3. Add to the app `EntityPage` component:

plugins/scaffolder-backend-module-cookiecutter/README.md

@@ -8,9 +8,9 @@ You need to configure the action in your backend:
 
 ## From your Backstage root directory
 
-```
-cd packages/backend
-yarn add @backstage/plugin-scaffolder-backend-module-cookiecutter
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-cookiecutter
 ```
 
 Configure the action:

plugins/scaffolder-backend-module-rails/README.md

@@ -13,9 +13,9 @@ You need to configure the action in your backend:
 
 ## From your Backstage root directory
 
-```
-cd packages/backend
-yarn add @backstage/plugin-scaffolder-backend-module-rails
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-rails
 ```
 
 Configure the action (you can check

plugins/scaffolder-backend-module-yeoman/README.md

@@ -8,9 +8,9 @@ You need to configure the action in your backend:
 
 ## From your Backstage root directory
 
-```
-cd packages/backend
-yarn add @backstage/plugin-scaffolder-backend-module-yeoman
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-yeoman
 ```
 
 Configure the action:

plugins/scaffolder-backend/README.md

@@ -21,8 +21,7 @@ restoring the plugin, if you previously removed it.
 
 ```bash
 # From your Backstage root directory
-cd packages/backend
-yarn add @backstage/plugin-scaffolder-backend
+yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend
 ```
 
 ### Adding the plugin to your `packages/backend`

plugins/scaffolder/README.md

@@ -20,8 +20,7 @@ the plugin, if you previously removed it.
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-scaffolder
+yarn add --cwd packages/app @backstage/plugin-scaffolder
 ```
 
 ### Add the plugin to your `packages/app`

plugins/sentry/README.md

@@ -10,8 +10,7 @@ The Sentry Plugin displays issues from [Sentry](https://sentry.io).
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-sentry
+yarn add --cwd packages/app @backstage/plugin-sentry
 ```
 
 2. Add the `EntitySentryCard` to the EntityPage:

plugins/sonarqube/README.md

@@ -10,8 +10,7 @@ The SonarQube Plugin displays code statistics from [SonarCloud](https://sonarclo
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-sonarqube
+yarn add --cwd packages/app @backstage/plugin-sonarqube
 ```
 
 2. Add the `EntitySonarQubeCard` to the EntityPage:

plugins/splunk-on-call/README.md

@@ -21,8 +21,7 @@ Install the plugin:
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-splunk-on-call
+yarn add --cwd packages/app @backstage/plugin-splunk-on-call
 ```
 
 Add it to your `EntityPage`:

plugins/tech-insights-backend-module-jsonfc/README.md

@@ -10,8 +10,7 @@ To add this FactChecker into your Tech Insights you need to install the module i
 
 ```bash
 # From your Backstage root directory
-cd packages/backend
-yarn add @backstage/plugin-tech-insights-backend-module-jsonfc
+yarn add --cwd packages/backend @backstage/plugin-tech-insights-backend-module-jsonfc
 ```
 
 and modify the `techInsights.ts` file to contain a reference to the FactCheckers implementation.

plugins/tech-insights-backend/README.md

@@ -10,8 +10,7 @@ as well as a framework to run fact retrievers and store fact values in to a data
 
 ```bash
 # From your Backstage root directory
-cd packages/backend
-yarn add @backstage/plugin-tech-insights-backend
+yarn add --cwd packages/backend @backstage/plugin-tech-insights-backend
 ```
 
 ### Adding the plugin to your `packages/backend`
@@ -197,8 +196,7 @@ To add the default FactChecker into your Tech Insights you need to install the m
 
 ```bash
 # From your Backstage root directory
-cd packages/backend
-yarn add @backstage/plugin-tech-insights-backend-module-jsonfc
+yarn add --cwd packages/backend @backstage/plugin-tech-insights-backend-module-jsonfc
 ```
 
 and modify the `techInsights.ts` file to contain a reference to the FactChecker implementation.

plugins/tech-insights/README.md

@@ -14,8 +14,7 @@ Main areas covered by this plugin currently are:
 
 ```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-tech-insights
+yarn add --cwd packages/app @backstage/plugin-tech-insights
 ```
 
 ### Add boolean checks overview (Scorecards) page to the EntityPage:

plugins/tech-radar/README.md

@@ -25,10 +25,9 @@ The Tech Radar can be used in two ways:
 
 For either simple or advanced installations, you'll need to add the dependency using Yarn:
 
-```sh
+```bash
 # From your Backstage root directory
-cd packages/app
-yarn add @backstage/plugin-tech-radar
+yarn add --cwd packages/app @backstage/plugin-tech-radar
 ```
 
 ### Configuration