diff --git a/.changeset/hot-horses-matter.md b/.changeset/hot-horses-matter.md new file mode 100644 index 0000000000..1b544c0854 --- /dev/null +++ b/.changeset/hot-horses-matter.md @@ -0,0 +1,108 @@ +--- +'@backstage/plugin-scaffolder-backend-module-confluence-to-markdown': patch +'@backstage/plugin-search-backend-module-stack-overflow-collator': patch +'@backstage/plugin-catalog-backend-module-incremental-ingestion': patch +'@backstage/plugin-scaffolder-backend-module-cookiecutter': patch +'@backstage/plugin-events-backend-module-bitbucket-cloud': patch +'@backstage/plugin-tech-insights-backend-module-jsonfc': patch +'@backstage/plugin-catalog-backend-module-unprocessed': patch +'@backstage/plugin-analytics-module-newrelic-browser': patch +'@backstage/plugin-scaffolder-backend-module-gitlab': patch +'@backstage/plugin-scaffolder-backend-module-sentry': patch +'@backstage/plugin-scaffolder-backend-module-yeoman': patch +'@backstage/plugin-catalog-backend-module-puppetdb': patch +'@backstage/plugin-scaffolder-backend-module-rails': patch +'@backstage/plugin-api-docs-module-protoc-gen-doc': patch +'@backstage/plugin-catalog-backend-module-msgraph': patch +'@backstage/plugin-catalog-backend-module-openapi': patch +'@backstage/plugin-search-backend-module-techdocs': patch +'@backstage/plugin-events-backend-module-aws-sqs': patch +'@backstage/plugin-search-backend-module-catalog': patch +'@backstage/plugin-search-backend-module-explore': patch +'@backstage/plugin-catalog-unprocessed-entities': patch +'@backstage/plugin-events-backend-module-gerrit': patch +'@backstage/plugin-events-backend-module-github': patch +'@backstage/plugin-events-backend-module-gitlab': patch +'@backstage/plugin-events-backend-module-azure': patch +'@backstage/plugin-entity-feedback-backend': patch +'@backstage/plugin-code-coverage-backend': patch +'@backstage/plugin-tech-insights-backend': patch +'@backstage/plugin-analytics-module-ga4': patch +'@backstage/plugin-azure-devops-backend': patch +'@backstage/backend-plugin-api': patch +'@backstage/plugin-analytics-module-ga': patch +'@backstage/plugin-azure-sites-backend': patch +'@backstage/backend-dev-utils': patch +'@backstage/plugin-github-deployments': patch +'@backstage/plugin-lighthouse-backend': patch +'@backstage/plugin-microsoft-calendar': patch +'@backstage/plugin-scaffolder-backend': patch +'@backstage/backend-defaults': patch +'@backstage/plugin-entity-validation': patch +'@backstage/plugin-sonarqube-backend': patch +'@backstage/backend-app-api': patch +'@backstage/plugin-devtools-backend': patch +'@backstage/plugin-linguist-backend': patch +'@backstage/plugin-playlist-backend': patch +'@backstage/backend-common': patch +'@backstage/plugin-catalog-backend': patch +'@backstage/plugin-explore-backend': patch +'@backstage/plugin-graphql-voyager': patch +'@backstage/plugin-jenkins-backend': patch +'@backstage/plugin-rollbar-backend': patch +'@backstage/backend-tasks': patch +'@backstage/plugin-badges-backend': patch +'@backstage/plugin-bazaar-backend': patch +'@backstage/plugin-catalog-import': patch +'@backstage/plugin-events-backend': patch +'@backstage/plugin-github-actions': patch +'@backstage/plugin-octopus-deploy': patch +'@backstage/plugin-splunk-on-call': patch +'@backstage/plugin-techdocs-react': patch +'@backstage/app-defaults': patch +'@backstage/core-app-api': patch +'@backstage/plugin-catalog-graph': patch +'@backstage/plugin-code-coverage': patch +'@backstage/plugin-cost-insights': patch +'@backstage/plugin-nomad-backend': patch +'@backstage/plugin-tech-insights': patch +'@backstage/plugin-vault-backend': patch +'@backstage/plugin-azure-devops': patch +'@backstage/plugin-code-climate': patch +'@backstage/plugin-adr-backend': patch +'@backstage/plugin-app-backend': patch +'@backstage/plugin-azure-sites': patch +'@backstage/plugin-firehydrant': patch +'@backstage/plugin-lighthouse': patch +'@backstage/plugin-scaffolder': patch +'@backstage/plugin-tech-radar': patch +'@backstage/plugin-codescene': patch +'@backstage/plugin-dynatrace': patch +'@backstage/plugin-shortcuts': patch +'@backstage/plugin-sonarqube': patch +'@backstage/plugin-xcmetrics': patch +'@backstage/plugin-airbrake': patch +'@backstage/plugin-api-docs': patch +'@backstage/plugin-circleci': patch +'@backstage/plugin-devtools': patch +'@backstage/plugin-graphiql': patch +'@backstage/plugin-linguist': patch +'@backstage/plugin-newrelic': patch +'@backstage/plugin-opencost': patch +'@backstage/plugin-periskop': patch +'@backstage/plugin-bitrise': patch +'@backstage/plugin-catalog': patch +'@backstage/plugin-jenkins': patch +'@backstage/plugin-rollbar': patch +'@backstage/plugin-allure': patch +'@backstage/plugin-badges': patch +'@backstage/plugin-bazaar': patch +'@backstage/plugin-sentry': patch +'@backstage/plugin-fossa': patch +'@backstage/plugin-ilert': patch +'@backstage/plugin-nomad': patch +'@backstage/plugin-vault': patch +'@backstage/plugin-home': patch +--- + +Use `--cwd` as the first `yarn` argument diff --git a/contrib/docs/tutorials/authenticate-api-requests.md b/contrib/docs/tutorials/authenticate-api-requests.md index 4c44c8ae65..8b71151ee9 100644 --- a/contrib/docs/tutorials/authenticate-api-requests.md +++ b/contrib/docs/tutorials/authenticate-api-requests.md @@ -88,7 +88,7 @@ Install cookie-parser: ```bash # From your Backstage root directory -yarn add --cwd packages/backend cookie-parser +yarn --cwd packages/backend add cookie-parser ``` Update routes in `packages/backend/src/index.ts`: @@ -223,7 +223,7 @@ Install cookie-parser: ```bash # From your Backstage root directory -yarn add --cwd packages/backend cookie-parser @types/cookie-parser +yarn --cwd packages/backend add cookie-parser @types/cookie-parser ``` Create a custom configured `rootHttpRouterService` in `packages/backend/src/customRootHttpRouterService.ts`: diff --git a/docs/backend-system/building-backends/08-migrating.md b/docs/backend-system/building-backends/08-migrating.md index fc1a6f1859..9eada30ef6 100644 --- a/docs/backend-system/building-backends/08-migrating.md +++ b/docs/backend-system/building-backends/08-migrating.md @@ -83,7 +83,7 @@ following command: ```bash # from the repository root -yarn add --cwd packages/backend @backstage/backend-defaults @backstage/backend-plugin-api +yarn --cwd packages/backend add @backstage/backend-defaults @backstage/backend-plugin-api ``` You should now be able to start this up with the familiar `yarn workspace @@ -616,7 +616,7 @@ if you didn't already have one. ```bash # from the repository root -yarn add --cwd packages/backend @backstage/plugin-catalog-node +yarn --cwd packages/backend add @backstage/plugin-catalog-node ``` Here we've placed the module directly in the backend index file just to get @@ -681,7 +681,7 @@ if you didn't already have one. ```bash # from the repository root -yarn add --cwd packages/backend @backstage/plugin-events-node +yarn --cwd packages/backend add @backstage/plugin-events-node ``` Here we've placed the module directly in the backend index file just to get @@ -715,7 +715,7 @@ And of course you'll need to install those separately as well. ```bash # from the repository root -yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-github +yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend-module-github ``` You can find a list of the available modules under the [plugins directory](https://github.com/backstage/backstage/tree/master/plugins) in the monorepo. @@ -766,7 +766,7 @@ if you didn't already have one. ```bash # from the repository root -yarn add --cwd packages/backend @backstage/plugin-scaffolder-node +yarn --cwd packages/backend add @backstage/plugin-scaffolder-node ``` Here we've placed the module directly in the backend index file just to get diff --git a/docs/features/kubernetes/installation.md b/docs/features/kubernetes/installation.md index 5111b5ad2e..bdd14098ff 100644 --- a/docs/features/kubernetes/installation.md +++ b/docs/features/kubernetes/installation.md @@ -17,7 +17,7 @@ application. ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-kubernetes +yarn --cwd packages/app add @backstage/plugin-kubernetes ``` Once the package has been installed, you need to import the plugin in your app @@ -55,7 +55,7 @@ Navigate to `packages/backend` of your Backstage app, and install the ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-kubernetes-backend +yarn --cwd packages/backend add @backstage/plugin-kubernetes-backend ``` Create a file called `kubernetes.ts` inside `packages/backend/src/plugins/` and diff --git a/docs/features/search/getting-started.md b/docs/features/search/getting-started.md index 1787189e91..7989b60ae2 100644 --- a/docs/features/search/getting-started.md +++ b/docs/features/search/getting-started.md @@ -18,7 +18,7 @@ If you haven't setup Backstage already, start ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-search @backstage/plugin-search-react +yarn --cwd packages/app add @backstage/plugin-search @backstage/plugin-search-react ``` Create a new `packages/app/src/components/search/SearchPage.tsx` file in your @@ -135,7 +135,7 @@ Add the following plugins into your backend app: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-search-backend @backstage/plugin-search-backend-node +yarn --cwd packages/backend add @backstage/plugin-search-backend @backstage/plugin-search-backend-node ``` Create a `packages/backend/src/plugins/search.ts` file containing the following diff --git a/docs/features/techdocs/addons.md b/docs/features/techdocs/addons.md index 2e17891917..471e62a57f 100644 --- a/docs/features/techdocs/addons.md +++ b/docs/features/techdocs/addons.md @@ -54,7 +54,7 @@ Addons are rendered in the order in which they are registered. ## Installing and using Addons -To start using Addons you need to add the `@backstage/plugin-techdocs-module-addons-contrib` package to your app. You can do that by running this command from the root of your project: `yarn add --cwd packages/app @backstage/plugin-techdocs-module-addons-contrib` +To start using Addons you need to add the `@backstage/plugin-techdocs-module-addons-contrib` package to your app. You can do that by running this command from the root of your project: `yarn --cwd packages/app add @backstage/plugin-techdocs-module-addons-contrib` Addons can be installed and configured in much the same way as extensions for other Backstage plugins: by adding them underneath an extension registry diff --git a/docs/features/techdocs/getting-started.md b/docs/features/techdocs/getting-started.md index f798384697..eaa6c2de72 100644 --- a/docs/features/techdocs/getting-started.md +++ b/docs/features/techdocs/getting-started.md @@ -23,7 +23,7 @@ Navigate to your new Backstage application directory. And then to your ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-techdocs +yarn --cwd packages/app add @backstage/plugin-techdocs ``` Once the package has been installed, you need to import the plugin in your app. @@ -108,7 +108,7 @@ Navigate to `packages/backend` of your Backstage app, and install the ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-techdocs-backend +yarn --cwd packages/backend add @backstage/plugin-techdocs-backend ``` Create a file called `techdocs.ts` inside `packages/backend/src/plugins/` and diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md index 5d797ecb4b..0c813b1aee 100644 --- a/docs/getting-started/configuration.md +++ b/docs/getting-started/configuration.md @@ -67,7 +67,7 @@ App. Use the following commands to start the PostgreSQL client installation: ```bash # From your Backstage root directory -yarn add --cwd packages/backend pg +yarn --cwd packages/backend add pg ``` Use your favorite editor to open `app-config.yaml` and add your PostgreSQL diff --git a/docs/getting-started/configure-app-with-plugins.md b/docs/getting-started/configure-app-with-plugins.md index 5611117636..724746ca16 100644 --- a/docs/getting-started/configure-app-with-plugins.md +++ b/docs/getting-started/configure-app-with-plugins.md @@ -23,7 +23,7 @@ to an entity in the software catalog. ```bash # From your Backstage root directory - yarn add --cwd packages/app @circleci/backstage-plugin + yarn --cwd packages/app add @circleci/backstage-plugin ``` Note the plugin is added to the `app` package, rather than the root diff --git a/docs/getting-started/homepage.md b/docs/getting-started/homepage.md index 04dfb13d6a..18f23f6607 100644 --- a/docs/getting-started/homepage.md +++ b/docs/getting-started/homepage.md @@ -30,7 +30,7 @@ Now, let's get started by installing the home plugin and creating a simple homep ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-home +yarn --cwd packages/app add @backstage/plugin-home ``` #### 2. Create a new HomePage component diff --git a/docs/integrations/aws-s3/discovery.md b/docs/integrations/aws-s3/discovery.md index ceb780141f..d664466a16 100644 --- a/docs/integrations/aws-s3/discovery.md +++ b/docs/integrations/aws-s3/discovery.md @@ -64,7 +64,7 @@ the AWS catalog plugin: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-aws +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-aws ``` Once you've done that, you'll also need to add the segment below to `packages/backend/src/plugins/catalog.ts`: diff --git a/docs/integrations/azure/discovery.md b/docs/integrations/azure/discovery.md index 3b25a9ac75..742fbb6076 100644 --- a/docs/integrations/azure/discovery.md +++ b/docs/integrations/azure/discovery.md @@ -98,7 +98,7 @@ the Azure catalog plugin: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-azure +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-azure ``` Once you've done that, you'll also need to add the segment below to `packages/backend/src/plugins/catalog.ts`: diff --git a/docs/integrations/azure/org.md b/docs/integrations/azure/org.md index 061baf7301..38c2e7618a 100644 --- a/docs/integrations/azure/org.md +++ b/docs/integrations/azure/org.md @@ -16,7 +16,7 @@ The package is not installed by default, therefore you have to add `@backstage/p ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-msgraph +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-msgraph ``` Next add the basic configuration to `app-config.yaml` diff --git a/docs/integrations/bitbucketCloud/discovery.md b/docs/integrations/bitbucketCloud/discovery.md index 53315a4c48..a7477a2a61 100644 --- a/docs/integrations/bitbucketCloud/discovery.md +++ b/docs/integrations/bitbucketCloud/discovery.md @@ -21,7 +21,7 @@ package. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-bitbucket-cloud +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-bitbucket-cloud ``` ### Installation without Events Support diff --git a/docs/integrations/bitbucketServer/discovery.md b/docs/integrations/bitbucketServer/discovery.md index ad59006ff1..f37732b600 100644 --- a/docs/integrations/bitbucketServer/discovery.md +++ b/docs/integrations/bitbucketServer/discovery.md @@ -21,7 +21,7 @@ package. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-bitbucket-server +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-bitbucket-server ``` And then add the entity provider to your catalog builder: diff --git a/docs/integrations/gerrit/discovery.md b/docs/integrations/gerrit/discovery.md index ee843d2454..e2922c1f76 100644 --- a/docs/integrations/gerrit/discovery.md +++ b/docs/integrations/gerrit/discovery.md @@ -18,7 +18,7 @@ the Gerrit provider plugin: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-gerrit +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-gerrit ``` Then add the plugin to the plugin catalog `packages/backend/src/plugins/catalog.ts`: diff --git a/docs/integrations/github/discovery.md b/docs/integrations/github/discovery.md index 3c3d90d6e9..461fab8af8 100644 --- a/docs/integrations/github/discovery.md +++ b/docs/integrations/github/discovery.md @@ -23,7 +23,7 @@ package. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-github +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github ``` And then add the entity provider to your catalog builder: @@ -250,7 +250,7 @@ package, plus `@backstage/integration` for the basic credentials management: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/integration @backstage/plugin-catalog-backend-module-github +yarn --cwd packages/backend add @backstage/integration @backstage/plugin-catalog-backend-module-github ``` And then add the processors to your catalog builder: diff --git a/docs/integrations/github/org.md b/docs/integrations/github/org.md index 1404b20559..263ceda6c6 100644 --- a/docs/integrations/github/org.md +++ b/docs/integrations/github/org.md @@ -27,7 +27,7 @@ to `@backstage/plugin-catalog-backend-module-github` to your backend package. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-github +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github ``` > Note: When configuring to use a Provider instead of a Processor you do not @@ -308,7 +308,7 @@ install and register it in the catalog plugin: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-github +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github ``` ```typescript title="packages/backend/src/plugins/catalog.ts" diff --git a/docs/integrations/gitlab/discovery.md b/docs/integrations/gitlab/discovery.md index 235d93ab03..d41f4f8de5 100644 --- a/docs/integrations/gitlab/discovery.md +++ b/docs/integrations/gitlab/discovery.md @@ -39,7 +39,7 @@ the gitlab catalog plugin: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-gitlab +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-gitlab ``` Once you've done that, you'll also need to add the segment below to `packages/backend/src/plugins/catalog.ts`: diff --git a/docs/integrations/gitlab/org.md b/docs/integrations/gitlab/org.md index ca40cefa9e..f2a483c9d1 100644 --- a/docs/integrations/gitlab/org.md +++ b/docs/integrations/gitlab/org.md @@ -15,7 +15,7 @@ As this provider is not one of the default providers, you will first need to ins ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-gitlab +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-gitlab ``` Then add the plugin to the plugin catalog `packages/backend/src/plugins/catalog.ts`: diff --git a/docs/integrations/ldap/org.md b/docs/integrations/ldap/org.md index 7306ab4105..9bc2667aa7 100644 --- a/docs/integrations/ldap/org.md +++ b/docs/integrations/ldap/org.md @@ -26,7 +26,7 @@ to `@backstage/plugin-catalog-backend-module-ldap` to your backend package. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-ldap +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-ldap ``` > Note: When configuring to use a Provider instead of a Processor you do not diff --git a/docs/permissions/getting-started.md b/docs/permissions/getting-started.md index 01a268f7ef..e241f0e38e 100644 --- a/docs/permissions/getting-started.md +++ b/docs/permissions/getting-started.md @@ -48,7 +48,7 @@ The permissions framework uses a new `permission-backend` plugin to accept autho ```bash # From your Backstage root directory - yarn add --cwd packages/backend @backstage/plugin-permission-backend + yarn --cwd packages/backend add @backstage/plugin-permission-backend ``` 2. Add the following to a new file, `packages/backend/src/plugins/permission.ts`. This adds the permission-backend router, and configures it with a policy which allows everything. diff --git a/docs/permissions/plugin-authors/01-setup.md b/docs/permissions/plugin-authors/01-setup.md index 8134fc0c39..a674d82e25 100644 --- a/docs/permissions/plugin-authors/01-setup.md +++ b/docs/permissions/plugin-authors/01-setup.md @@ -41,8 +41,8 @@ The source code is available here: ```sh # From your Backstage root directory - yarn add --cwd packages/backend @internal/plugin-todo-list-backend @internal/plugin-todo-list-common - yarn add --cwd packages/app @internal/plugin-todo-list + yarn --cwd packages/backend add @internal/plugin-todo-list-backend @internal/plugin-todo-list-common + yarn --cwd packages/app add @internal/plugin-todo-list ``` 3. Include the backend and frontend plugin in your application: diff --git a/docs/plugins/backend-plugin.md b/docs/plugins/backend-plugin.md index d2e93bb08c..22d4bae371 100644 --- a/docs/plugins/backend-plugin.md +++ b/docs/plugins/backend-plugin.md @@ -69,7 +69,7 @@ to your backend. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @internal/plugin-carmen-backend@^0.1.0 # Change this to match the plugin's package.json +yarn --cwd packages/backend add @internal/plugin-carmen-backend@^0.1.0 # Change this to match the plugin's package.json ``` Create a new file named `packages/backend/src/plugins/carmen.ts`, and add the diff --git a/docs/tutorials/configuring-plugin-databases.md b/docs/tutorials/configuring-plugin-databases.md index 8cd5ce99a9..528d2c6325 100644 --- a/docs/tutorials/configuring-plugin-databases.md +++ b/docs/tutorials/configuring-plugin-databases.md @@ -39,10 +39,10 @@ both of them. ```bash # From your Backstage root directory # install pg if you need PostgreSQL -yarn add --cwd packages/backend pg +yarn --cwd packages/backend add pg # install SQLite 3 if you intend to set it as the client -yarn add --cwd packages/backend better-sqlite3 +yarn --cwd packages/backend add better-sqlite3 ``` From an operational perspective, you only need to install drivers for clients diff --git a/docs/tutorials/switching-sqlite-postgres.md b/docs/tutorials/switching-sqlite-postgres.md index 87afabda60..2ef481dbf3 100644 --- a/docs/tutorials/switching-sqlite-postgres.md +++ b/docs/tutorials/switching-sqlite-postgres.md @@ -21,7 +21,7 @@ First, add PostgreSQL to your `backend` package: ```bash # From your Backstage root directory -yarn add --cwd packages/backend pg +yarn --cwd packages/backend add pg ``` ## Add PostgreSQL configuration diff --git a/microsite/blog/2020-04-30-how-to-quickly-set-up-backstage.mdx b/microsite/blog/2020-04-30-how-to-quickly-set-up-backstage.mdx index 4884762560..b59f943245 100644 --- a/microsite/blog/2020-04-30-how-to-quickly-set-up-backstage.mdx +++ b/microsite/blog/2020-04-30-how-to-quickly-set-up-backstage.mdx @@ -102,7 +102,7 @@ Install in your app’s package folder (`/packages/app`) with: ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin- +yarn --cwd packages/app add @backstage/plugin- ``` After that, you inject the plugin into the application where you want it to be exposed. Please read the documentation for the specific plugin you are installing for more information. diff --git a/packages/app-defaults/README.md b/packages/app-defaults/README.md index cfdaf36acb..ebaaacafe3 100644 --- a/packages/app-defaults/README.md +++ b/packages/app-defaults/README.md @@ -8,7 +8,7 @@ Install the package via Yarn: ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/app-defaults +yarn --cwd packages/app add @backstage/app-defaults ``` ## Documentation diff --git a/packages/backend-app-api/README.md b/packages/backend-app-api/README.md index 3fd6170b4f..7ac3767ece 100644 --- a/packages/backend-app-api/README.md +++ b/packages/backend-app-api/README.md @@ -8,7 +8,7 @@ Add the library to your backend app package: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/backend-app-api +yarn --cwd packages/backend add @backstage/backend-app-api ``` ## Documentation diff --git a/packages/backend-common/README.md b/packages/backend-common/README.md index 578fbc0830..71a15bfb5a 100644 --- a/packages/backend-common/README.md +++ b/packages/backend-common/README.md @@ -9,7 +9,7 @@ Add the library to your backend package: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/backend-common +yarn --cwd packages/backend add @backstage/backend-common ``` then make use of the handlers and logger as necessary: diff --git a/packages/backend-defaults/README.md b/packages/backend-defaults/README.md index 01e42d42c4..a1bf881929 100644 --- a/packages/backend-defaults/README.md +++ b/packages/backend-defaults/README.md @@ -8,7 +8,7 @@ Add the library to your backend app package: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/backend-defaults +yarn --cwd packages/backend add @backstage/backend-defaults ``` ## Documentation diff --git a/packages/backend-dev-utils/README.md b/packages/backend-dev-utils/README.md index 744a9d2ca0..f3666ea33e 100644 --- a/packages/backend-dev-utils/README.md +++ b/packages/backend-dev-utils/README.md @@ -8,7 +8,7 @@ Add the library to your backend plugin or module package: ```bash # From your Backstage root directory -yarn add --cwd plugins/-backend @backstage/backend-dev-utils +yarn --cwd plugins/-backend add @backstage/backend-dev-utils ``` ## Documentation diff --git a/packages/backend-plugin-api/README.md b/packages/backend-plugin-api/README.md index b827ecc50c..1e5e4cf3b1 100644 --- a/packages/backend-plugin-api/README.md +++ b/packages/backend-plugin-api/README.md @@ -8,7 +8,7 @@ Add the library to your backend plugin or module package: ```bash # From your Backstage root directory -yarn add --cwd plugins/-backend @backstage/backend-plugin-api +yarn --cwd plugins/-backend add @backstage/backend-plugin-api ``` ## Documentation diff --git a/packages/backend-tasks/README.md b/packages/backend-tasks/README.md index afaca06e55..57cd63b0e0 100644 --- a/packages/backend-tasks/README.md +++ b/packages/backend-tasks/README.md @@ -8,7 +8,7 @@ Add the library to your backend package: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/backend-tasks +yarn --cwd packages/backend add @backstage/backend-tasks ``` then make use of its facilities as necessary: diff --git a/packages/core-app-api/README.md b/packages/core-app-api/README.md index ffdc0ef94a..94dd618625 100644 --- a/packages/core-app-api/README.md +++ b/packages/core-app-api/README.md @@ -7,7 +7,7 @@ This package provides the core API used by Backstage apps. Install the package via Yarn: ```bash -yarn add --cwd packages/app @backstage/core-app-api +yarn --cwd packages/app add @backstage/core-app-api ``` ## Documentation diff --git a/plugins/adr-backend/README.md b/plugins/adr-backend/README.md index 6ce2f13ebf..ebf99b4ee1 100644 --- a/plugins/adr-backend/README.md +++ b/plugins/adr-backend/README.md @@ -20,7 +20,7 @@ Here's how to get the backend up and running: ```sh # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-adr-backend +yarn --cwd packages/backend add @backstage/plugin-adr-backend ``` 2. Then we will create a new file named `packages/backend/src/plugins/adr.ts`, and add the diff --git a/plugins/airbrake/README.md b/plugins/airbrake/README.md index 573910a1cf..603311f92c 100644 --- a/plugins/airbrake/README.md +++ b/plugins/airbrake/README.md @@ -8,14 +8,14 @@ The Airbrake plugin provides connectivity between Backstage and Airbrake (https: ```bash # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-airbrake + yarn --cwd packages/app add @backstage/plugin-airbrake ``` 2. Install the Backend plugin: ```bash # From your Backstage root directory - yarn add --cwd packages/backend @backstage/plugin-airbrake-backend + yarn --cwd packages/backend add @backstage/plugin-airbrake-backend ``` 3. Add the `EntityAirbrakeContent` and `isAirbrakeAvailable` to `packages/app/src/components/catalog/EntityPage.tsx` for all the entity pages you want Airbrake to be in: diff --git a/plugins/allure/README.md b/plugins/allure/README.md index 3a1137fc39..22348385a3 100644 --- a/plugins/allure/README.md +++ b/plugins/allure/README.md @@ -6,7 +6,7 @@ Welcome to the Backstage Allure plugin. This plugin add an entity service page t ```shell # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-allure +yarn --cwd packages/app add @backstage/plugin-allure ``` ## Configure diff --git a/plugins/analytics-module-ga/README.md b/plugins/analytics-module-ga/README.md index 6fdfc91306..dfea532403 100644 --- a/plugins/analytics-module-ga/README.md +++ b/plugins/analytics-module-ga/README.md @@ -12,7 +12,7 @@ This plugin contains no other functionality. ```sh # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-analytics-module-ga +yarn --cwd packages/app add @backstage/plugin-analytics-module-ga ``` 2. Wire up the API implementation to your App: diff --git a/plugins/analytics-module-ga4/README.md b/plugins/analytics-module-ga4/README.md index 2d8c930e30..dad9b88a27 100644 --- a/plugins/analytics-module-ga4/README.md +++ b/plugins/analytics-module-ga4/README.md @@ -12,7 +12,7 @@ This plugin contains no other functionality. ```sh # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-analytics-module-ga4 +yarn --cwd packages/app add @backstage/plugin-analytics-module-ga4 ``` 2. Wire up the API implementation to your App: diff --git a/plugins/analytics-module-newrelic-browser/README.md b/plugins/analytics-module-newrelic-browser/README.md index 2fe3956d2d..d607a4f446 100644 --- a/plugins/analytics-module-newrelic-browser/README.md +++ b/plugins/analytics-module-newrelic-browser/README.md @@ -10,7 +10,7 @@ This plugin contains no other functionality. ```sh # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-analytics-module-newrelic-browser +yarn --cwd packages/app add @backstage/plugin-analytics-module-newrelic-browser ``` 2. Wire up the API implementation to your App: diff --git a/plugins/api-docs-module-protoc-gen-doc/README.md b/plugins/api-docs-module-protoc-gen-doc/README.md index a921fafc0b..5bf75766e0 100644 --- a/plugins/api-docs-module-protoc-gen-doc/README.md +++ b/plugins/api-docs-module-protoc-gen-doc/README.md @@ -8,7 +8,7 @@ This package contains ApiDefinitionWidgets for the following projects: ```sh # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-api-docs-module-protoc-gen-doc +yarn --cwd packages/app add @backstage/plugin-api-docs-module-protoc-gen-doc ``` ## Add the GrpcDocsApiWidget to your apis diff --git a/plugins/api-docs/README.md b/plugins/api-docs/README.md index 46d9df4628..9b8eb1669e 100644 --- a/plugins/api-docs/README.md +++ b/plugins/api-docs/README.md @@ -29,7 +29,7 @@ To link that a component provides or consumes an API, see the [`providesApis`](h ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-api-docs +yarn --cwd packages/app add @backstage/plugin-api-docs ``` 2. Add the `ApiExplorerPage` extension to the app: diff --git a/plugins/app-backend/README.md b/plugins/app-backend/README.md index 590c6e8eb7..0f0c235ab5 100644 --- a/plugins/app-backend/README.md +++ b/plugins/app-backend/README.md @@ -8,7 +8,7 @@ Add both this package and your local frontend app package as dependencies to you ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-app-backend app +yarn --cwd packages/backend add @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. diff --git a/plugins/azure-devops-backend/README.md b/plugins/azure-devops-backend/README.md index 0066e43856..f69951f70d 100644 --- a/plugins/azure-devops-backend/README.md +++ b/plugins/azure-devops-backend/README.md @@ -37,7 +37,7 @@ Here's how to get the backend up and running: ```sh # From your Backstage root directory - yarn add --cwd packages/backend @backstage/plugin-azure-devops-backend + yarn --cwd packages/backend add @backstage/plugin-azure-devops-backend ``` 2. Then we will create a new file named `packages/backend/src/plugins/azure-devops.ts`, and add the diff --git a/plugins/azure-devops/README.md b/plugins/azure-devops/README.md index 7119cb0980..f897588987 100644 --- a/plugins/azure-devops/README.md +++ b/plugins/azure-devops/README.md @@ -146,7 +146,7 @@ To get the Azure Pipelines component working you'll need to do the following two ```bash # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-azure-devops + yarn --cwd packages/app add @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: @@ -204,7 +204,7 @@ To get the Azure Repos component working you'll need to do the following two ste ```bash # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-azure-devops + yarn --cwd packages/app add @backstage/plugin-azure-devops ``` 2. Second we need to add the `EntityAzurePullRequestsContent` extension to the entity page in your app: @@ -241,7 +241,7 @@ To get the Git Tags component working you'll need to do the following two steps: ```bash # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-azure-devops + yarn --cwd packages/app add @backstage/plugin-azure-devops ``` 2. Second we need to add the `EntityAzureGitTagsContent` extension to the entity page in your app: @@ -277,7 +277,7 @@ To get the README component working you'll need to do the following two steps: ```bash # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-azure-devops + yarn --cwd packages/app add @backstage/plugin-azure-devops ``` 2. Second we need to add the `EntityAzureReadmeCard` extension to the entity page in your app: diff --git a/plugins/azure-sites-backend/README.md b/plugins/azure-sites-backend/README.md index 5017be8a8f..892cbe4024 100644 --- a/plugins/azure-sites-backend/README.md +++ b/plugins/azure-sites-backend/README.md @@ -37,7 +37,7 @@ Here's how to get the backend plugin up and running: ```sh # From the Backstage root directory - yarn add --cwd packages/backend @backstage/plugin-azure-sites-backend + yarn --cwd packages/backend add @backstage/plugin-azure-sites-backend ``` 2. Then we will create a new file named `packages/backend/src/plugins/azure-sites.ts`, and add the following to it: diff --git a/plugins/azure-sites/README.md b/plugins/azure-sites/README.md index a19b314b77..540daeb7df 100644 --- a/plugins/azure-sites/README.md +++ b/plugins/azure-sites/README.md @@ -48,7 +48,7 @@ azure.com/microsoft-web-sites: func-testapp ```sh # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-azure-sites +yarn --cwd packages/app add @backstage/plugin-azure-sites ``` 2. Add widget component to your Backstage instance: diff --git a/plugins/badges-backend/README.md b/plugins/badges-backend/README.md index 22c3311ff1..1737482080 100644 --- a/plugins/badges-backend/README.md +++ b/plugins/badges-backend/README.md @@ -15,7 +15,7 @@ Install the `@backstage/plugin-badges-backend` package in your backend package: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-badges-backend +yarn --cwd packages/backend add @backstage/plugin-badges-backend ``` Add the plugin using the following default setup for diff --git a/plugins/badges/README.md b/plugins/badges/README.md index 4b8ff38d47..06c0e3e413 100644 --- a/plugins/badges/README.md +++ b/plugins/badges/README.md @@ -80,7 +80,7 @@ Install the `@backstage/plugin-badges` package in your frontend app package: ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-badges +yarn --cwd packages/app add @backstage/plugin-badges ``` ### Register plugin diff --git a/plugins/bazaar-backend/README.md b/plugins/bazaar-backend/README.md index 266841b26b..eec1574b7a 100644 --- a/plugins/bazaar-backend/README.md +++ b/plugins/bazaar-backend/README.md @@ -8,7 +8,7 @@ Welcome to the Bazaar backend plugin! ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-bazaar-backend +yarn --cwd packages/backend add @backstage/plugin-bazaar-backend ``` ## Adding the plugin to your `packages/backend` diff --git a/plugins/bazaar/README.md b/plugins/bazaar/README.md index 941979d4d3..c340baec3e 100644 --- a/plugins/bazaar/README.md +++ b/plugins/bazaar/README.md @@ -22,7 +22,7 @@ First install the plugin into your app: ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-bazaar +yarn --cwd packages/app add @backstage/plugin-bazaar ``` Modify your app routes in `packages/app/src/App.tsx` to include the `Bazaar` component exported from the plugin, for example: diff --git a/plugins/bitrise/README.md b/plugins/bitrise/README.md index e5d5c2122c..80c3dadac9 100644 --- a/plugins/bitrise/README.md +++ b/plugins/bitrise/README.md @@ -9,7 +9,7 @@ Welcome to the Bitrise plugin! ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-bitrise +yarn --cwd packages/app add @backstage/plugin-bitrise ``` Bitrise Plugin exposes an entity tab component named `EntityBitriseContent`. You can include it in the diff --git a/plugins/catalog-backend-module-incremental-ingestion/README.md b/plugins/catalog-backend-module-incremental-ingestion/README.md index c5ed3e6367..0894d32031 100644 --- a/plugins/catalog-backend-module-incremental-ingestion/README.md +++ b/plugins/catalog-backend-module-incremental-ingestion/README.md @@ -41,7 +41,7 @@ The Incremental Entity Provider backend is designed for data sources that provid ## Installation -1. Install `@backstage/plugin-catalog-backend-module-incremental-ingestion` with `yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-incremental-ingestion` from the Backstage root directory. +1. Install `@backstage/plugin-catalog-backend-module-incremental-ingestion` with `yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-incremental-ingestion` from the Backstage root directory. 2. In your catalog.ts, import `IncrementalCatalogBuilder` from `@backstage/plugin-catalog-backend-module-incremental-ingestion` and instantiate it with `await IncrementalCatalogBuilder.create(env, builder)`. You have to pass `builder` into `IncrementalCatalogBuilder.create` function because `IncrementalCatalogBuilder` will convert an `IncrementalEntityProvider` into an `EntityProvider` and call `builder.addEntityProvider`. ```ts diff --git a/plugins/catalog-backend-module-msgraph/README.md b/plugins/catalog-backend-module-msgraph/README.md index b70134cba3..e3ed302fa9 100644 --- a/plugins/catalog-backend-module-msgraph/README.md +++ b/plugins/catalog-backend-module-msgraph/README.md @@ -104,7 +104,7 @@ By default, all users are loaded. If you want to filter users based on their att ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-msgraph +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-msgraph ``` 4. The `MicrosoftGraphOrgEntityProvider` is not registered by default, so you diff --git a/plugins/catalog-backend-module-openapi/README.md b/plugins/catalog-backend-module-openapi/README.md index 6a8028895d..a79416e901 100644 --- a/plugins/catalog-backend-module-openapi/README.md +++ b/plugins/catalog-backend-module-openapi/README.md @@ -12,7 +12,7 @@ This is useful for OpenAPI and AsyncAPI specifications. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-openapi +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-openapi ``` ### Adding the plugin to your `packages/backend` diff --git a/plugins/catalog-backend-module-puppetdb/README.md b/plugins/catalog-backend-module-puppetdb/README.md index 9319299a06..a3291693e8 100644 --- a/plugins/catalog-backend-module-puppetdb/README.md +++ b/plugins/catalog-backend-module-puppetdb/README.md @@ -12,7 +12,7 @@ to your backend package: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-puppetdb +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-puppetdb ``` Update the catalog plugin initialization in your backend to add the provider and schedule it: diff --git a/plugins/catalog-backend-module-unprocessed/README.md b/plugins/catalog-backend-module-unprocessed/README.md index f2ea7b7741..0d9f9f8cb9 100644 --- a/plugins/catalog-backend-module-unprocessed/README.md +++ b/plugins/catalog-backend-module-unprocessed/README.md @@ -11,7 +11,7 @@ A `pending` entity has not been processed yet. ## Installation ```shell -yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-unprocessed +yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-unprocessed ``` ### backend diff --git a/plugins/catalog-backend/README.md b/plugins/catalog-backend/README.md index cd921499d3..7f886de155 100644 --- a/plugins/catalog-backend/README.md +++ b/plugins/catalog-backend/README.md @@ -27,7 +27,7 @@ restoring the plugin, if you previously removed it. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-catalog-backend +yarn --cwd packages/backend add @backstage/plugin-catalog-backend ``` ### Adding the plugin to your `packages/backend` diff --git a/plugins/catalog-graph/README.md b/plugins/catalog-graph/README.md index f00d11810f..1b972082d5 100644 --- a/plugins/catalog-graph/README.md +++ b/plugins/catalog-graph/README.md @@ -27,7 +27,7 @@ To use the catalog graph plugin, you have to add some things to your Backstage a 1. Add a dependency to your `packages/app/package.json`: ```sh # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-catalog-graph + yarn --cwd packages/app add @backstage/plugin-catalog-graph ``` 2. Add the `CatalogGraphPage` to your `packages/app/src/App.tsx`: diff --git a/plugins/catalog-import/README.md b/plugins/catalog-import/README.md index 602e67503d..d4ede8af7b 100644 --- a/plugins/catalog-import/README.md +++ b/plugins/catalog-import/README.md @@ -19,7 +19,7 @@ Some features are not yet available for all supported Git providers. ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-catalog-import +yarn --cwd packages/app add @backstage/plugin-catalog-import ``` 2. Add the `CatalogImportPage` extension to the app: diff --git a/plugins/catalog-unprocessed-entities/README.md b/plugins/catalog-unprocessed-entities/README.md index 3c9f649e37..c2e5109d5c 100644 --- a/plugins/catalog-unprocessed-entities/README.md +++ b/plugins/catalog-unprocessed-entities/README.md @@ -29,7 +29,7 @@ Requires the `@backstage/plugin-catalog-backend-module-unprocessed` module to be ## Installation ```shell -yarn add --cwd packages/app @backstage/plugin-catalog-unprocessed-entities +yarn --cwd packages/app add @backstage/plugin-catalog-unprocessed-entities ``` Import into your `App.tsx` and include into the `` component: diff --git a/plugins/catalog/README.md b/plugins/catalog/README.md index b35110053e..1ce7b2bf69 100644 --- a/plugins/catalog/README.md +++ b/plugins/catalog/README.md @@ -20,7 +20,7 @@ plugin, if you previously removed it. ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-catalog +yarn --cwd packages/app add @backstage/plugin-catalog ``` ### Add the plugin to your `packages/app` diff --git a/plugins/circleci/README.md b/plugins/circleci/README.md index 86af7081c7..67e342e8c8 100644 --- a/plugins/circleci/README.md +++ b/plugins/circleci/README.md @@ -15,7 +15,7 @@ ```bash # From your Backstage root directory -yarn add --cwd packages/app @circleci/backstage-plugin +yarn --cwd packages/app add @circleci/backstage-plugin ``` 2. Add the `EntityCircleCIContent` extension to the entity page in your app: diff --git a/plugins/code-climate/README.md b/plugins/code-climate/README.md index 4140f8f1aa..8aff5cd9af 100644 --- a/plugins/code-climate/README.md +++ b/plugins/code-climate/README.md @@ -10,7 +10,7 @@ The Code Climate Plugin displays a few stats from the quality section from [Code ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-code-climate +yarn --cwd packages/app add @backstage/plugin-code-climate ``` 2. Add the `EntityCodeClimateCard` to the EntityPage: diff --git a/plugins/code-coverage-backend/README.md b/plugins/code-coverage-backend/README.md index 2b22b0ad1d..f47e966466 100644 --- a/plugins/code-coverage-backend/README.md +++ b/plugins/code-coverage-backend/README.md @@ -6,7 +6,7 @@ This is the backend part of the `code-coverage` plugin. It takes care of process ```sh # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-code-coverage-backend +yarn --cwd packages/backend add @backstage/plugin-code-coverage-backend ``` First create a `codecoverage.ts` file here: `packages/backend/src/plugins`. Now add the following as its content: diff --git a/plugins/code-coverage/README.md b/plugins/code-coverage/README.md index d4daa6ec00..4298c69b11 100644 --- a/plugins/code-coverage/README.md +++ b/plugins/code-coverage/README.md @@ -6,7 +6,7 @@ This is the frontend part of the code-coverage plugin. It displays code coverage ```sh # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-code-coverage +yarn --cwd packages/app add @backstage/plugin-code-coverage ``` Finally you need to import and render the code coverage entity, in `packages/app/src/components/catalog/EntityPage.tsx` add the following: diff --git a/plugins/codescene/README.md b/plugins/codescene/README.md index 8c84c9015c..1a713c1589 100644 --- a/plugins/codescene/README.md +++ b/plugins/codescene/README.md @@ -12,7 +12,7 @@ The CodeScene Backstage Plugin provides a page component that displays a list of ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-codescene +yarn --cwd packages/app add @backstage/plugin-codescene ``` 2. Add the routes and pages to your `App.tsx`: diff --git a/plugins/cost-insights/README.md b/plugins/cost-insights/README.md index a7bcb0cb0a..b7bfa053cf 100644 --- a/plugins/cost-insights/README.md +++ b/plugins/cost-insights/README.md @@ -17,7 +17,7 @@ Learn more with the Backstage blog post [New Cost Insights plugin: The engineer' ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-cost-insights +yarn --cwd packages/app add @backstage/plugin-cost-insights ``` ## Setup @@ -224,8 +224,8 @@ costInsights: ### Engineer Threshold (Optional; default 0.5) -This threshold determines whether to show 'Negligible', or a percentage with a fraction of 'engineers' for cost savings or cost excess on top of the charts. -A threshold of 0.5 means that `Negligible` is shown when the difference in costs is lower than that fraction of engineers in that time frame, +This threshold determines whether to show 'Negligible', or a percentage with a fraction of 'engineers' for cost savings or cost excess on top of the charts. +A threshold of 0.5 means that `Negligible` is shown when the difference in costs is lower than that fraction of engineers in that time frame, and show `XX% or ~N engineers` when it's above the threshold. ```yaml diff --git a/plugins/cost-insights/contrib/aws-cost-explorer-api.md b/plugins/cost-insights/contrib/aws-cost-explorer-api.md index 4fbf8a0cbe..abe6d10120 100644 --- a/plugins/cost-insights/contrib/aws-cost-explorer-api.md +++ b/plugins/cost-insights/contrib/aws-cost-explorer-api.md @@ -34,7 +34,7 @@ Install the AWS Cost Explorer SDK. The AWS docs recommend using the SDK over mak ```bash # From your Backstage root directory -yarn add --cwd packages/app @aws-sdk/client-cost-explorer +yarn --cwd packages/app add @aws-sdk/client-cost-explorer ``` ## Usage of the SDK diff --git a/plugins/devtools-backend/README.md b/plugins/devtools-backend/README.md index 528e864783..c9226a92ab 100644 --- a/plugins/devtools-backend/README.md +++ b/plugins/devtools-backend/README.md @@ -10,7 +10,7 @@ Here's how to get the DevTools Backend up and running: ```sh # From the Backstage root directory - yarn add --cwd packages/backend @backstage/plugin-devtools-backend + yarn --cwd packages/backend add @backstage/plugin-devtools-backend ``` 2. Then we will create a new file named `packages/backend/src/plugins/devtools.ts`, and add the diff --git a/plugins/devtools/README.md b/plugins/devtools/README.md index cb6fbb95fd..f6db8d1417 100644 --- a/plugins/devtools/README.md +++ b/plugins/devtools/README.md @@ -14,7 +14,7 @@ Lists helpful information about your current running Backstage instance such as: #### Backstage Version Reporting -The Backstage Version that is reported requires `backstage.json` to be present at the root of the running backstage instance. +The Backstage Version that is reported requires `backstage.json` to be present at the root of the running backstage instance. You may need to modify your Dockerfile to ensure `backstage.json` is copied into the `WORKDIR` of your image. ```sh @@ -66,7 +66,7 @@ To setup the DevTools frontend you'll need to do the following steps: ```sh # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-devtools + yarn --cwd packages/app add @backstage/plugin-devtools ``` 2. Now open the `packages/app/src/App.tsx` file @@ -206,7 +206,7 @@ To use the permission framework to secure the DevTools sidebar option you'll wan ```sh # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-devtools-common + yarn --cwd packages/app add @backstage/plugin-devtools-common ``` 2. Then open the `packages/app/src/components/Root/Root.tsx` file @@ -236,7 +236,7 @@ To use the permission framework to secure the DevTools route you'll want to do t ```sh # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-devtools-common + yarn --cwd packages/app add @backstage/plugin-devtools-common ``` 2. Then open the `packages/app/src/App.tsx` file @@ -341,7 +341,7 @@ To use this policy you'll need to make sure to add the `@backstage/plugin-devtoo ```sh # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-devtools-common +yarn --cwd packages/backend add @backstage/plugin-devtools-common ``` You'll also need to add these imports: diff --git a/plugins/dynatrace/README.md b/plugins/dynatrace/README.md index 9143b0ff9c..5e2394cee3 100644 --- a/plugins/dynatrace/README.md +++ b/plugins/dynatrace/README.md @@ -28,7 +28,7 @@ The Dynatrace plugin will require the following information, to be used in the c ``` # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-dynatrace +yarn --cwd packages/app add @backstage/plugin-dynatrace ``` 2. We created in our catalog the interface for using the integration with Dynatrace. diff --git a/plugins/entity-feedback-backend/README.md b/plugins/entity-feedback-backend/README.md index 49a8ce20e0..a3aae695e2 100644 --- a/plugins/entity-feedback-backend/README.md +++ b/plugins/entity-feedback-backend/README.md @@ -12,7 +12,7 @@ out of the box, this plugin will not work when you test it. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-entity-feedback-backend +yarn --cwd packages/backend add @backstage/plugin-entity-feedback-backend ``` ### Adding the plugin to your `packages/backend` diff --git a/plugins/entity-validation/README.md b/plugins/entity-validation/README.md index 7816262836..f831007a45 100644 --- a/plugins/entity-validation/README.md +++ b/plugins/entity-validation/README.md @@ -10,7 +10,7 @@ First of all, install the package in the `app` package by running the following ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-entity-validation +yarn --cwd packages/app add @backstage/plugin-entity-validation ``` Add the new route to the app by adding the following line: diff --git a/plugins/events-backend-module-aws-sqs/README.md b/plugins/events-backend-module-aws-sqs/README.md index 397de35c10..7ca4bb280d 100644 --- a/plugins/events-backend-module-aws-sqs/README.md +++ b/plugins/events-backend-module-aws-sqs/README.md @@ -38,7 +38,7 @@ events: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-events-backend-module-aws-sqs +yarn --cwd packages/backend add @backstage/plugin-events-backend-module-aws-sqs ``` ```ts title="packages/backend/src/index.ts" diff --git a/plugins/events-backend-module-azure/README.md b/plugins/events-backend-module-azure/README.md index 457fd81fbc..61b3b63175 100644 --- a/plugins/events-backend-module-azure/README.md +++ b/plugins/events-backend-module-azure/README.md @@ -28,7 +28,7 @@ Install this module: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-events-backend-module-azure +yarn --cwd packages/backend add @backstage/plugin-events-backend-module-azure ``` ### Add to backend diff --git a/plugins/events-backend-module-bitbucket-cloud/README.md b/plugins/events-backend-module-bitbucket-cloud/README.md index d70a70c87e..0a40ab2eea 100644 --- a/plugins/events-backend-module-bitbucket-cloud/README.md +++ b/plugins/events-backend-module-bitbucket-cloud/README.md @@ -28,7 +28,7 @@ Install this module: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-events-backend-module-bitbucket-cloud +yarn --cwd packages/backend add @backstage/plugin-events-backend-module-bitbucket-cloud ``` ### Add to backend diff --git a/plugins/events-backend-module-gerrit/README.md b/plugins/events-backend-module-gerrit/README.md index 34b2d154be..b658fba366 100644 --- a/plugins/events-backend-module-gerrit/README.md +++ b/plugins/events-backend-module-gerrit/README.md @@ -27,7 +27,7 @@ Install this module: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-events-backend-module-gerrit +yarn --cwd packages/backend add @backstage/plugin-events-backend-module-gerrit ``` ### Add to backend diff --git a/plugins/events-backend-module-github/README.md b/plugins/events-backend-module-github/README.md index 7731d10d24..072877ee86 100644 --- a/plugins/events-backend-module-github/README.md +++ b/plugins/events-backend-module-github/README.md @@ -28,7 +28,7 @@ Install this module: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-events-backend-module-github +yarn --cwd packages/backend add @backstage/plugin-events-backend-module-github ``` Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`: diff --git a/plugins/events-backend-module-gitlab/README.md b/plugins/events-backend-module-gitlab/README.md index 13e30659a6..3d4919302f 100644 --- a/plugins/events-backend-module-gitlab/README.md +++ b/plugins/events-backend-module-gitlab/README.md @@ -27,7 +27,7 @@ Install this module: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-events-backend-module-gitlab +yarn --cwd packages/backend add @backstage/plugin-events-backend-module-gitlab ``` Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`: diff --git a/plugins/events-backend/README.md b/plugins/events-backend/README.md index 2fd980f003..b8470101aa 100644 --- a/plugins/events-backend/README.md +++ b/plugins/events-backend/README.md @@ -21,7 +21,7 @@ to the used event broker. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-events-backend @backstage/plugin-events-node +yarn --cwd packages/backend add @backstage/plugin-events-backend @backstage/plugin-events-node ``` ### Add to backend diff --git a/plugins/explore-backend/README.md b/plugins/explore-backend/README.md index aae3ff94b8..6767749eab 100644 --- a/plugins/explore-backend/README.md +++ b/plugins/explore-backend/README.md @@ -13,7 +13,7 @@ Install dependencies ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-explore-backend +yarn --cwd packages/backend add @backstage/plugin-explore-backend ``` Add feature @@ -45,7 +45,7 @@ Install dependencies ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-explore-backend +yarn --cwd packages/backend add @backstage/plugin-explore-backend ``` You'll need to add the plugin to the router in your `backend` package. You can @@ -90,7 +90,7 @@ Install dependencies ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-explore-backend @backstage/plugin-explore-common +yarn --cwd packages/backend add @backstage/plugin-explore-backend @backstage/plugin-explore-common ``` You'll need to add the plugin to the router in your `backend` package. You can diff --git a/plugins/firehydrant/README.md b/plugins/firehydrant/README.md index 4472536245..aa56bd066a 100644 --- a/plugins/firehydrant/README.md +++ b/plugins/firehydrant/README.md @@ -18,7 +18,7 @@ The [FireHydrant](https://firehydrant.io) plugin brings incident management to B ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-firehydrant +yarn --cwd packages/app add @backstage/plugin-firehydrant ``` 2. Add the plugin to `EntityPage.tsx`, inside the `const overviewContent`'s parent `` component: diff --git a/plugins/fossa/README.md b/plugins/fossa/README.md index 10ccba5ba7..2c69a9b309 100644 --- a/plugins/fossa/README.md +++ b/plugins/fossa/README.md @@ -10,7 +10,7 @@ The FOSSA Plugin displays code statistics from [FOSSA](https://fossa.com/). ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-fossa +yarn --cwd packages/app add @backstage/plugin-fossa ``` 2. Add the `EntityFossaCard` to the EntityPage: diff --git a/plugins/github-actions/README.md b/plugins/github-actions/README.md index d0b5ceb54d..4be62346a5 100644 --- a/plugins/github-actions/README.md +++ b/plugins/github-actions/README.md @@ -39,7 +39,7 @@ TBD ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-github-actions +yarn --cwd packages/app add @backstage/plugin-github-actions ``` 2. Add to the app `EntityPage` component: diff --git a/plugins/github-deployments/README.md b/plugins/github-deployments/README.md index 5cc6ccdeaa..111e028eed 100644 --- a/plugins/github-deployments/README.md +++ b/plugins/github-deployments/README.md @@ -14,7 +14,7 @@ The GitHub Deployments Plugin displays recent deployments from GitHub. ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-github-deployments +yarn --cwd packages/app add @backstage/plugin-github-deployments ``` 2. Add the `EntityGithubDeploymentsCard` to the EntityPage: diff --git a/plugins/graphiql/README.md b/plugins/graphiql/README.md index 452dfa807d..ed47b96967 100644 --- a/plugins/graphiql/README.md +++ b/plugins/graphiql/README.md @@ -13,7 +13,7 @@ Start out by installing the plugin in your Backstage app: ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-graphiql +yarn --cwd packages/app add @backstage/plugin-graphiql ``` ```diff diff --git a/plugins/graphql-voyager/README.md b/plugins/graphql-voyager/README.md index 66ea63191b..d37ffdecca 100644 --- a/plugins/graphql-voyager/README.md +++ b/plugins/graphql-voyager/README.md @@ -13,7 +13,7 @@ To get started, first install the plugin with the following command: ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-graphql-voyager +yarn --cwd packages/app add @backstage/plugin-graphql-voyager ``` ### Adding the page diff --git a/plugins/home/README.md b/plugins/home/README.md index 066e637725..35f9cb0738 100644 --- a/plugins/home/README.md +++ b/plugins/home/README.md @@ -10,7 +10,7 @@ If you have a standalone app (you didn't clone this repo), then do ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-home +yarn --cwd packages/app add @backstage/plugin-home ``` ### Setting up the Home Page diff --git a/plugins/ilert/README.md b/plugins/ilert/README.md index 814baea507..434cf8c0f0 100644 --- a/plugins/ilert/README.md +++ b/plugins/ilert/README.md @@ -27,7 +27,7 @@ Install the plugin: ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-ilert +yarn --cwd packages/app add @backstage/plugin-ilert ``` Add it to the `EntityPage.tsx`: diff --git a/plugins/jenkins-backend/README.md b/plugins/jenkins-backend/README.md index d6f8fa5472..4cca86f86d 100644 --- a/plugins/jenkins-backend/README.md +++ b/plugins/jenkins-backend/README.md @@ -28,7 +28,7 @@ This plugin needs to be added to an existing backstage instance. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-jenkins-backend +yarn --cwd packages/backend add @backstage/plugin-jenkins-backend ``` Typically, this means creating a `src/plugins/jenkins.ts` file and adding a reference to it to `src/index.ts` diff --git a/plugins/jenkins/README.md b/plugins/jenkins/README.md index b62eaab514..bdbe0ac0d9 100644 --- a/plugins/jenkins/README.md +++ b/plugins/jenkins/README.md @@ -14,7 +14,7 @@ Website: [https://jenkins.io/](https://jenkins.io/) ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-jenkins +yarn --cwd packages/app add @backstage/plugin-jenkins ``` 2. Add and configure the [jenkins-backend](../jenkins-backend) plugin according to it's instructions diff --git a/plugins/lighthouse-backend/README.md b/plugins/lighthouse-backend/README.md index 687467f1d5..06455d90b4 100644 --- a/plugins/lighthouse-backend/README.md +++ b/plugins/lighthouse-backend/README.md @@ -8,7 +8,7 @@ Lighthouse Backend allows you to run scheduled lighthouse Tests for each Website ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-lighthouse-backend +yarn --cwd packages/backend add @backstage/plugin-lighthouse-backend ``` 2. Create a `lighthouse.ts` file inside `packages/backend/src/plugins/`: diff --git a/plugins/lighthouse/README.md b/plugins/lighthouse/README.md index e834ad39c1..ee0e1dfd1d 100644 --- a/plugins/lighthouse/README.md +++ b/plugins/lighthouse/README.md @@ -29,7 +29,7 @@ When you have an instance running that Backstage can hook into, first install th ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-lighthouse +yarn --cwd packages/app add @backstage/plugin-lighthouse ``` Modify your app routes in `App.tsx` to include the `LighthousePage` component exported from the plugin, for example: diff --git a/plugins/lighthouse/src/components/Intro/index.tsx b/plugins/lighthouse/src/components/Intro/index.tsx index 8701c473aa..4c102b7587 100644 --- a/plugins/lighthouse/src/components/Intro/index.tsx +++ b/plugins/lighthouse/src/components/Intro/index.tsx @@ -52,7 +52,7 @@ When you have an instance running that Backstage can hook into, first install th \`\`\`sh # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-lighthouse +yarn --cwd packages/app add @backstage/plugin-lighthouse \`\`\` Modify your app routes in \`App.tsx\` to include the \`LighthousePage\` component exported from the plugin, for example: diff --git a/plugins/linguist-backend/README.md b/plugins/linguist-backend/README.md index d2ed7f5f03..3bc441c238 100644 --- a/plugins/linguist-backend/README.md +++ b/plugins/linguist-backend/README.md @@ -14,7 +14,7 @@ Here's how to get the backend up and running: ```sh # From the Backstage root directory - yarn add --cwd packages/backend @backstage/plugin-linguist-backend + yarn --cwd packages/backend add @backstage/plugin-linguist-backend ``` 2. Then we will create a new file named `packages/backend/src/plugins/linguist.ts`, and add the diff --git a/plugins/linguist/README.md b/plugins/linguist/README.md index e7cad1c8e0..7ad70f1db6 100644 --- a/plugins/linguist/README.md +++ b/plugins/linguist/README.md @@ -55,7 +55,7 @@ To setup the Linguist Card frontend you'll need to do the following steps: ```sh # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-linguist + yarn --cwd packages/app add @backstage/plugin-linguist ``` 2. Second we need to add the `EntityLinguistCard` extension to the entity page in your app: diff --git a/plugins/microsoft-calendar/README.md b/plugins/microsoft-calendar/README.md index 3dcf58c418..f5ba17bde3 100644 --- a/plugins/microsoft-calendar/README.md +++ b/plugins/microsoft-calendar/README.md @@ -25,7 +25,7 @@ The following sections will help you set up the Microsoft calendar plugin. ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-microsoft-calendar +yarn --cwd packages/app add @backstage/plugin-microsoft-calendar ``` 2. Import the Microsoft calendar React component from `@backstage/plugin-microsoft-calendar`. diff --git a/plugins/newrelic/README.md b/plugins/newrelic/README.md index 14049ba39c..14e2c0005d 100644 --- a/plugins/newrelic/README.md +++ b/plugins/newrelic/README.md @@ -48,7 +48,7 @@ APIs. 2. Add a dependency to your `packages/app/package.json`: ```sh # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-newrelic + yarn --cwd packages/app add @backstage/plugin-newrelic ``` 3. Add the `NewRelicPage` to your `packages/app/src/App.tsx`: diff --git a/plugins/nomad-backend/README.md b/plugins/nomad-backend/README.md index 231f1ddccb..9f530bd943 100644 --- a/plugins/nomad-backend/README.md +++ b/plugins/nomad-backend/README.md @@ -22,7 +22,7 @@ In your `packages/backend/src/index.ts` make the following changes: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-nomad-backend +yarn --cwd packages/backend add @backstage/plugin-nomad-backend ``` 2. Create a `nomad.ts` file inside `packages/backend/src/plugins/`: diff --git a/plugins/nomad/README.md b/plugins/nomad/README.md index da14a0a3f3..443669b71a 100644 --- a/plugins/nomad/README.md +++ b/plugins/nomad/README.md @@ -31,7 +31,7 @@ If your Nomad cluster has ACLs enabled, you will need a `token` with at least th ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-nomad +yarn --cwd packages/app add @backstage/plugin-nomad ``` ### Configuration diff --git a/plugins/octopus-deploy/README.md b/plugins/octopus-deploy/README.md index 3699b76678..ee7d9d8543 100644 --- a/plugins/octopus-deploy/README.md +++ b/plugins/octopus-deploy/README.md @@ -14,7 +14,7 @@ To get started, first install the plugin with the following command: ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-octopus-deploy +yarn --cwd packages/app add @backstage/plugin-octopus-deploy ``` ### Setup diff --git a/plugins/opencost/README.md b/plugins/opencost/README.md index 05c63206a2..1dec15dcc1 100644 --- a/plugins/opencost/README.md +++ b/plugins/opencost/README.md @@ -11,7 +11,7 @@ All of the code was originally ported from https://github.com/opencost/opencost/ 1. Add the OpenCost dependency to the `packages/app/package.json`: ```sh # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-opencost + yarn --cwd packages/app add @backstage/plugin-opencost ``` 2. Add the `OpenCostPage` to your `packages/app/src/App.tsx`: diff --git a/plugins/periskop/README.md b/plugins/periskop/README.md index 192948402a..85bced7c1b 100644 --- a/plugins/periskop/README.md +++ b/plugins/periskop/README.md @@ -19,7 +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 -yarn add --cwd packages/app @backstage/plugin-periskop +yarn --cwd packages/app add @backstage/plugin-periskop ``` 3. Add to the app `EntityPage` component: @@ -53,7 +53,7 @@ annotations: ### Instances -The periskop plugin can be configured to fetch aggregated errors from multiple deployment instances. +The periskop plugin can be configured to fetch aggregated errors from multiple deployment instances. This is especially useful if you have a multi-zone deployment, or a federated setup and would like to drill deeper into a single instance of the federation. Each of the configured instances will be included in the plugin's UI via a dropdown on the errors table. The plugin requires to configure _at least one_ Periskop API location in the [app-config.yaml](https://github.com/backstage/backstage/blob/master/app-config.yaml): diff --git a/plugins/playlist-backend/README.md b/plugins/playlist-backend/README.md index b5c9b8797b..d4474e2331 100644 --- a/plugins/playlist-backend/README.md +++ b/plugins/playlist-backend/README.md @@ -8,7 +8,7 @@ Welcome to the playlist backend plugin! ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-playlist-backend +yarn --cwd packages/backend add @backstage/plugin-playlist-backend ``` ### Adding the plugin to your `packages/backend` diff --git a/plugins/rollbar-backend/README.md b/plugins/rollbar-backend/README.md index d28ee60181..1f5977f5df 100644 --- a/plugins/rollbar-backend/README.md +++ b/plugins/rollbar-backend/README.md @@ -8,7 +8,7 @@ Simple plugin that proxies requests to the [Rollbar](https://rollbar.com) API. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-rollbar-backend +yarn --cwd packages/backend add @backstage/plugin-rollbar-backend ``` 2. Create a `rollbar.ts` file inside `packages/backend/src/plugins/`: diff --git a/plugins/rollbar/README.md b/plugins/rollbar/README.md index 99a3deb763..2b1fb7e40d 100644 --- a/plugins/rollbar/README.md +++ b/plugins/rollbar/README.md @@ -10,7 +10,7 @@ Website: [https://rollbar.com/](https://rollbar.com/) ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-rollbar +yarn --cwd packages/app add @backstage/plugin-rollbar ``` 3. Add to the app `EntityPage` component: diff --git a/plugins/scaffolder-backend-module-confluence-to-markdown/README.md b/plugins/scaffolder-backend-module-confluence-to-markdown/README.md index 87f6acc6fe..1e64004041 100644 --- a/plugins/scaffolder-backend-module-confluence-to-markdown/README.md +++ b/plugins/scaffolder-backend-module-confluence-to-markdown/README.md @@ -12,7 +12,7 @@ From your Backstage root directory run: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-confluence-to-markdown +yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend-module-confluence-to-markdown ``` Then configure the action: diff --git a/plugins/scaffolder-backend-module-cookiecutter/README.md b/plugins/scaffolder-backend-module-cookiecutter/README.md index 0e8e11ef7d..62c6eede97 100644 --- a/plugins/scaffolder-backend-module-cookiecutter/README.md +++ b/plugins/scaffolder-backend-module-cookiecutter/README.md @@ -10,7 +10,7 @@ You need to configure the action in your backend: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-cookiecutter +yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend-module-cookiecutter ``` Configure the action: diff --git a/plugins/scaffolder-backend-module-gitlab/README.md b/plugins/scaffolder-backend-module-gitlab/README.md index c946c8b476..bb31769cef 100644 --- a/plugins/scaffolder-backend-module-gitlab/README.md +++ b/plugins/scaffolder-backend-module-gitlab/README.md @@ -10,7 +10,7 @@ Here you can find all Gitlab related features to improve your scaffolder: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-gitlab +yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend-module-gitlab ``` Configure the action: diff --git a/plugins/scaffolder-backend-module-rails/README.md b/plugins/scaffolder-backend-module-rails/README.md index f4ec086775..a7afd1429e 100644 --- a/plugins/scaffolder-backend-module-rails/README.md +++ b/plugins/scaffolder-backend-module-rails/README.md @@ -15,7 +15,7 @@ You need to configure the action in your backend: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-rails +yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend-module-rails ``` Configure the action (you can check diff --git a/plugins/scaffolder-backend-module-sentry/README.md b/plugins/scaffolder-backend-module-sentry/README.md index 14751185c4..5cb1f1b810 100644 --- a/plugins/scaffolder-backend-module-sentry/README.md +++ b/plugins/scaffolder-backend-module-sentry/README.md @@ -12,7 +12,7 @@ You need to configure the action in your backend: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-sentry +yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend-module-sentry ``` Configure the action (you can check diff --git a/plugins/scaffolder-backend-module-yeoman/README.md b/plugins/scaffolder-backend-module-yeoman/README.md index b5c7b4d026..05bbf6064b 100644 --- a/plugins/scaffolder-backend-module-yeoman/README.md +++ b/plugins/scaffolder-backend-module-yeoman/README.md @@ -10,7 +10,7 @@ You need to configure the action in your backend: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-yeoman +yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend-module-yeoman ``` Configure the action: diff --git a/plugins/scaffolder-backend/README.md b/plugins/scaffolder-backend/README.md index ba9183c5cc..0aa57fd90c 100644 --- a/plugins/scaffolder-backend/README.md +++ b/plugins/scaffolder-backend/README.md @@ -21,7 +21,7 @@ restoring the plugin, if you previously removed it. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend +yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend ``` ### Adding the plugin to your `packages/backend` diff --git a/plugins/scaffolder/README.md b/plugins/scaffolder/README.md index 80d59160c4..a6af441d62 100644 --- a/plugins/scaffolder/README.md +++ b/plugins/scaffolder/README.md @@ -20,7 +20,7 @@ the plugin, if you previously removed it. ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-scaffolder +yarn --cwd packages/app add @backstage/plugin-scaffolder ``` ### Add the plugin to your `packages/app` diff --git a/plugins/search-backend-module-catalog/README.md b/plugins/search-backend-module-catalog/README.md index a2825c17cd..cbabe13d6d 100644 --- a/plugins/search-backend-module-catalog/README.md +++ b/plugins/search-backend-module-catalog/README.md @@ -8,7 +8,7 @@ Add the module package as a dependency: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-search-backend-module-catalog +yarn --cwd packages/backend add @backstage/plugin-search-backend-module-catalog ``` Add the collator to your backend instance, along with the search plugin itself: diff --git a/plugins/search-backend-module-explore/README.md b/plugins/search-backend-module-explore/README.md index 9ba33ae326..5bccf8c737 100644 --- a/plugins/search-backend-module-explore/README.md +++ b/plugins/search-backend-module-explore/README.md @@ -8,7 +8,7 @@ Add the module package as a dependency: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-search-backend-module-explore +yarn --cwd packages/backend add @backstage/plugin-search-backend-module-explore ``` Add the collator to your backend instance, along with the search plugin itself: diff --git a/plugins/search-backend-module-stack-overflow-collator/README.md b/plugins/search-backend-module-stack-overflow-collator/README.md index 4790917375..e2d516ace5 100644 --- a/plugins/search-backend-module-stack-overflow-collator/README.md +++ b/plugins/search-backend-module-stack-overflow-collator/README.md @@ -73,7 +73,7 @@ Add the module package as a dependency: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-search-backend-module-stack-overflow-collator +yarn --cwd packages/backend add @backstage/plugin-search-backend-module-stack-overflow-collator ``` Add the collator to your backend instance, along with the search plugin itself: diff --git a/plugins/search-backend-module-techdocs/README.md b/plugins/search-backend-module-techdocs/README.md index 04c884efb0..68bb4b956e 100644 --- a/plugins/search-backend-module-techdocs/README.md +++ b/plugins/search-backend-module-techdocs/README.md @@ -8,7 +8,7 @@ Add the module package as a dependency: ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-search-backend-module-techdocs +yarn --cwd packages/backend add @backstage/plugin-search-backend-module-techdocs ``` Add the collator to your backend instance, along with the search plugin itself: diff --git a/plugins/sentry/README.md b/plugins/sentry/README.md index 7cc015eb13..78f31952b2 100644 --- a/plugins/sentry/README.md +++ b/plugins/sentry/README.md @@ -10,7 +10,7 @@ The Sentry Plugin displays issues from [Sentry](https://sentry.io). ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-sentry +yarn --cwd packages/app add @backstage/plugin-sentry ``` 2. Add the `EntitySentryCard` to the EntityPage: diff --git a/plugins/shortcuts/README.md b/plugins/shortcuts/README.md index 46b878a579..18deb7ae37 100644 --- a/plugins/shortcuts/README.md +++ b/plugins/shortcuts/README.md @@ -8,7 +8,7 @@ The shortcuts plugin allows a user to have easy access to pages within a Backsta ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-shortcuts +yarn --cwd packages/app add @backstage/plugin-shortcuts ``` ### Register plugin: diff --git a/plugins/sonarqube-backend/README.md b/plugins/sonarqube-backend/README.md index 4eeac67498..6206cd8257 100644 --- a/plugins/sonarqube-backend/README.md +++ b/plugins/sonarqube-backend/README.md @@ -22,7 +22,7 @@ This plugin needs to be added to an existing backstage instance. ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-sonarqube-backend +yarn --cwd packages/backend add @backstage/plugin-sonarqube-backend ``` Typically, this means creating a `src/plugins/sonarqube.ts` file and adding a reference to it to `src/index.ts` in the backend package. diff --git a/plugins/sonarqube/README.md b/plugins/sonarqube/README.md index ab85d128aa..9d3bc701f9 100644 --- a/plugins/sonarqube/README.md +++ b/plugins/sonarqube/README.md @@ -10,7 +10,7 @@ The SonarQube Plugin displays code statistics from [SonarCloud](https://sonarclo ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-sonarqube +yarn --cwd packages/app add @backstage/plugin-sonarqube ``` 2. Add the `EntitySonarQubeCard` to the EntityPage: diff --git a/plugins/splunk-on-call/README.md b/plugins/splunk-on-call/README.md index fd14b311c6..ceeec2fa4c 100644 --- a/plugins/splunk-on-call/README.md +++ b/plugins/splunk-on-call/README.md @@ -21,7 +21,7 @@ Install the plugin: ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-splunk-on-call +yarn --cwd packages/app add @backstage/plugin-splunk-on-call ``` Add it to your `EntityPage`: diff --git a/plugins/tech-insights-backend-module-jsonfc/README.md b/plugins/tech-insights-backend-module-jsonfc/README.md index c405ac34ef..33b3ad7718 100644 --- a/plugins/tech-insights-backend-module-jsonfc/README.md +++ b/plugins/tech-insights-backend-module-jsonfc/README.md @@ -10,7 +10,7 @@ To add this FactChecker into your Tech Insights you need to install the module i ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-tech-insights-backend-module-jsonfc +yarn --cwd packages/backend add @backstage/plugin-tech-insights-backend-module-jsonfc ``` ### Add to the backend diff --git a/plugins/tech-insights-backend/README.md b/plugins/tech-insights-backend/README.md index 29b374c18c..56b927a10e 100644 --- a/plugins/tech-insights-backend/README.md +++ b/plugins/tech-insights-backend/README.md @@ -10,7 +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 -yarn add --cwd packages/backend @backstage/plugin-tech-insights-backend +yarn --cwd packages/backend add @backstage/plugin-tech-insights-backend ``` ### Adding the plugin to your `packages/backend` @@ -214,7 +214,7 @@ To add the default FactChecker into your Tech Insights you need to install the m ```bash # From your Backstage root directory -yarn add --cwd packages/backend @backstage/plugin-tech-insights-backend-module-jsonfc +yarn --cwd packages/backend add @backstage/plugin-tech-insights-backend-module-jsonfc ``` and modify the `techInsights.ts` file to contain a reference to the FactChecker implementation. diff --git a/plugins/tech-insights/README.md b/plugins/tech-insights/README.md index 3185d40441..9145e892e7 100644 --- a/plugins/tech-insights/README.md +++ b/plugins/tech-insights/README.md @@ -14,7 +14,7 @@ Main areas covered by this plugin currently are: ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-tech-insights +yarn --cwd packages/app add @backstage/plugin-tech-insights ``` ### Add boolean checks overview (Scorecards) page to the EntityPage: diff --git a/plugins/tech-radar/README.md b/plugins/tech-radar/README.md index 31d90de938..a28ced777e 100644 --- a/plugins/tech-radar/README.md +++ b/plugins/tech-radar/README.md @@ -27,7 +27,7 @@ For either simple or advanced installations, you'll need to add the dependency u ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-tech-radar +yarn --cwd packages/app add @backstage/plugin-tech-radar ``` ### Configuration diff --git a/plugins/techdocs-react/README.md b/plugins/techdocs-react/README.md index 53e9fc6a3a..e0f792064c 100644 --- a/plugins/techdocs-react/README.md +++ b/plugins/techdocs-react/README.md @@ -6,5 +6,5 @@ This package provides frontend utilities for TechDocs and Addons. ```sh # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-techdocs-react +yarn --cwd packages/app add @backstage/plugin-techdocs-react ``` diff --git a/plugins/vault-backend/README.md b/plugins/vault-backend/README.md index 117bcaacbb..2c7dd06e52 100644 --- a/plugins/vault-backend/README.md +++ b/plugins/vault-backend/README.md @@ -16,7 +16,7 @@ To get started, first you need a running instance of Vault. You can follow [this ```bash # From your Backstage root directory - yarn add --cwd packages/backend @backstage/plugin-vault-backend + yarn --cwd packages/backend add @backstage/plugin-vault-backend ``` 2. Create a file in `src/plugins/vault.ts` and add a reference to it in `src/index.ts`: diff --git a/plugins/vault/README.md b/plugins/vault/README.md index ce2df6e47a..fe86a30bd2 100644 --- a/plugins/vault/README.md +++ b/plugins/vault/README.md @@ -18,7 +18,7 @@ To get started, first you need a running instance of Vault. You can follow [this ```bash # From your Backstage root directory - yarn add --cwd packages/app @backstage/plugin-vault + yarn --cwd packages/app add @backstage/plugin-vault ``` 2. Add the Vault card to the overview tab on the EntityPage: diff --git a/plugins/xcmetrics/README.md b/plugins/xcmetrics/README.md index 7c003722a0..0823cbbb24 100644 --- a/plugins/xcmetrics/README.md +++ b/plugins/xcmetrics/README.md @@ -1,6 +1,6 @@ # XCMetrics -[XCMetrics](https://xcmetrics.io) is a tool for collecting build metrics from XCode. +[XCMetrics](https://xcmetrics.io) is a tool for collecting build metrics from XCode. With this plugin, you can view data from XCMetrics directly in Backstage. ![XCMetrics-overview](./docs/XCMetrics-overview.png) @@ -9,7 +9,7 @@ With this plugin, you can view data from XCMetrics directly in Backstage. ```bash # From your Backstage root directory -yarn add --cwd packages/app @backstage/plugin-xcmetrics +yarn --cwd packages/app add @backstage/plugin-xcmetrics ``` In `packages/app/src/App.tsx`, add the following: diff --git a/scripts/verify-lockfile-duplicates.js b/scripts/verify-lockfile-duplicates.js index ddf99f4fd6..5c9adb72f0 100644 --- a/scripts/verify-lockfile-duplicates.js +++ b/scripts/verify-lockfile-duplicates.js @@ -95,11 +95,11 @@ async function main() { if (failed) { if (!fix) { - const command = `yarn dedupe${ + const command = `yarn${ lockFile.directoryRelativeToProjectRoot === '.' ? '' : ` --cwd ${lockFile.directoryRelativeToProjectRoot}` - }`; + } dedupe`; const padding = ' '.repeat(Math.max(0, 85 - 6 - command.length)); console.error(''); console.error(