diff --git a/ADOPTERS.md b/ADOPTERS.md index 9630ee8c9a..439a2d40be 100644 --- a/ADOPTERS.md +++ b/ADOPTERS.md @@ -34,7 +34,7 @@ _If you're using Backstage in your organization, please try to add your company | [Netflix](https://www.netflix.com/) | [bleathem](https://github.com/bleathem) | Our Backstage implementation will be the front door to a unified experience connecting our internal platform products across important workflows with integrated knowledge and support. | | [b.well](https://www.icanbwell.com/) | [Jacob Rosales](https://github.com/jrosales) | Foundation for our engineering portal and cloud insights. | | [PagerDuty](https://www.pagerduty.com/) | [Mark Shaw](https://github.com/markshawtoronto) | Developer portal, initially focused on software templates and tech-docs. | -| [MoonShiner](https://moonshiner.at) | [Fabian Hippmann](https://github.com/FabianHippmann) | Developer portal - helps us keep track of our customer projects, onboard new developers & improve our development process 🌕🚀🧑‍🚀 | +| [MoonShiner](https://moonshiner.at) | [Fabian Hippmann](https://github.com/FabianHippmann) | Developer portal - helps us keep track of our customer projects, onboard new developers & improve our development process 🌕🚀🧑‍🚀 | | [FundApps](https://www.fundapps.co/) | [Elliot Greenwood](https://github.com/egnwd) | Developer Portal - A place for us to keep track of our projects and documentation for all services and processes | | [DAZN](https://dazn.com/) | [Lou Bichard](https://twitter.com/loujaybee), [Marco Crivellaro](https://github.com/crivetechie), [Alex Hollerith](mailto:alex.hollerith@dazn.com) | Ingesting all of DAZN's repos for the catalog, migrating our internal platform apps (pull request boards, release information, inner source marketplace etc) to Backstage plugins (where applicable). | | [HelloFresh](https://www.hellofresh.de/) | [@iammuho](https://github.com/iammuho), [@ElenaForester](https://github.com/ElenaForester), [@diegomarangoni](https://github.com/diegomarangoni) | Our developer portal at HelloFresh - Spread across an organisation of 500+ engineers globally. | diff --git a/docs/integrations/azure/discovery.md b/docs/integrations/azure/discovery.md index ba58acd538..9293b6d9d7 100644 --- a/docs/integrations/azure/discovery.md +++ b/docs/integrations/azure/discovery.md @@ -73,4 +73,10 @@ When using a custom pattern, the target is composed of five parts: _Note:_ the path parameter follows the same rules as the search on Azure DevOps web interface. For more details visit the -[official search documentation](https://docs.microsoft.com/en-us/azure/devops/project/search/get-started-search?view=azure-devops) +[official search documentation](https://docs.microsoft.com/en-us/azure/devops/project/search/get-started-search?view=azure-devops). + +Azure discovery is driven by the Code Search feature in Azure DevOps, this may not be enabled by default. For Azure +DevOps Services you can confirm this by looking at the installed extensions in your Organization Settings. For Azure +DevOps Server you'll find this information in your Collection Settings. + +If the Code Search extension is not listed then you can install it from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=ms.vss-code-search&targetId=f9352dac-ba6e-434e-9241-a848a510ce3f&utm_source=vstsproduct&utm_medium=SearchExtStatus). diff --git a/microsite/blog/2020-04-30-how-to-quickly-set-up-backstage.md b/microsite/blog/2020-04-30-how-to-quickly-set-up-backstage.md index 7289878bc1..17f095f1fb 100644 --- a/microsite/blog/2020-04-30-how-to-quickly-set-up-backstage.md +++ b/microsite/blog/2020-04-30-how-to-quickly-set-up-backstage.md @@ -102,8 +102,7 @@ Install in your app’s package folder (`/packages/app`) with: ```bash # From your Backstage root directory -cd packages/app -yarn add @backstage/plugin- +yarn add --cwd packages/app @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 15a0bd3d24..cfdaf36acb 100644 --- a/packages/app-defaults/README.md +++ b/packages/app-defaults/README.md @@ -6,9 +6,9 @@ This package provides a default wiring of a Backstage app that avoids boilerplat Install the package via Yarn: -```sh -cd packages/app -yarn add @backstage/app-defaults +```bash +# From your Backstage root directory +yarn add --cwd packages/app @backstage/app-defaults ``` ## Documentation diff --git a/packages/backend-common/README.md b/packages/backend-common/README.md index dc69790bc3..a1ebf18841 100644 --- a/packages/backend-common/README.md +++ b/packages/backend-common/README.md @@ -7,10 +7,9 @@ error handling and similar. Add the library to your backend package: -```sh +```bash # From your Backstage root directory -cd packages/backend -yarn add @backstage/backend-common +yarn add --cwd packages/backend @backstage/backend-common ``` then make use of the handlers and logger as necessary: diff --git a/packages/backend-tasks/README.md b/packages/backend-tasks/README.md index 1bfab8a89b..d170c323c8 100644 --- a/packages/backend-tasks/README.md +++ b/packages/backend-tasks/README.md @@ -6,10 +6,9 @@ Common distributed task management for Backstage backends. Add the library to your backend package: -```sh +```bash # From your Backstage root directory -cd packages/backend -yarn add @backstage/backend-tasks +yarn add --cwd packages/backend @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 f98021250f..ffdc0ef94a 100644 --- a/packages/core-app-api/README.md +++ b/packages/core-app-api/README.md @@ -6,9 +6,8 @@ This package provides the core API used by Backstage apps. Install the package via Yarn: -```sh -cd packages/app -yarn add @backstage/core-app-api +```bash +yarn add --cwd packages/app @backstage/core-app-api ``` ## Documentation diff --git a/packages/core-plugin-api/src/analytics/AnalyticsContext.tsx b/packages/core-plugin-api/src/analytics/AnalyticsContext.tsx index af362cd921..e3bf616d74 100644 --- a/packages/core-plugin-api/src/analytics/AnalyticsContext.tsx +++ b/packages/core-plugin-api/src/analytics/AnalyticsContext.tsx @@ -21,8 +21,9 @@ import { import React, { ReactNode, useContext } from 'react'; import { AnalyticsContextValue } from './types'; -const AnalyticsReactContext = - createVersionedContext<{ 1: AnalyticsContextValue }>('analytics-context'); +const AnalyticsReactContext = createVersionedContext<{ + 1: AnalyticsContextValue; +}>('analytics-context'); /** * A "private" (to this package) hook that enables context inheritance and a diff --git a/plugins/airbrake/README.md b/plugins/airbrake/README.md index 1aae77bd47..bc30ca7896 100644 --- a/plugins/airbrake/README.md +++ b/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: diff --git a/plugins/api-docs/README.md b/plugins/api-docs/README.md index 4919690568..51588aacf4 100644 --- a/plugins/api-docs/README.md +++ b/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: diff --git a/plugins/app-backend/README.md b/plugins/app-backend/README.md index 21e0253bac..590c6e8eb7 100644 --- a/plugins/app-backend/README.md +++ b/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. diff --git a/plugins/azure-devops/README.md b/plugins/azure-devops/README.md index e06c3c81ec..a55ed983b7 100644 --- a/plugins/azure-devops/README.md +++ b/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: diff --git a/plugins/bazaar-backend/README.md b/plugins/bazaar-backend/README.md index 01b240e0e3..b7a08a2fb8 100644 --- a/plugins/bazaar-backend/README.md +++ b/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` diff --git a/plugins/bazaar/README.md b/plugins/bazaar/README.md index dea25727b0..eeebf6eb19 100644 --- a/plugins/bazaar/README.md +++ b/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: diff --git a/plugins/bitrise/README.md b/plugins/bitrise/README.md index 1add03df23..9c99f28568 100644 --- a/plugins/bitrise/README.md +++ b/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 diff --git a/plugins/catalog-backend-module-msgraph/README.md b/plugins/catalog-backend-module-msgraph/README.md index bf23e93770..1fd5fc3f19 100644 --- a/plugins/catalog-backend-module-msgraph/README.md +++ b/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 diff --git a/plugins/catalog-backend/README.md b/plugins/catalog-backend/README.md index ce97bb7a54..fbd0fd4a91 100644 --- a/plugins/catalog-backend/README.md +++ b/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` diff --git a/plugins/catalog-import/README.md b/plugins/catalog-import/README.md index 86f3aecba9..602e67503d 100644 --- a/plugins/catalog-import/README.md +++ b/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: diff --git a/plugins/catalog/README.md b/plugins/catalog/README.md index ef7b0a2863..74d0f9e901 100644 --- a/plugins/catalog/README.md +++ b/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` diff --git a/plugins/circleci/README.md b/plugins/circleci/README.md index c878c66e56..fa80469991 100644 --- a/plugins/circleci/README.md +++ b/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: diff --git a/plugins/code-climate/README.md b/plugins/code-climate/README.md index a67e70b11a..4140f8f1aa 100644 --- a/plugins/code-climate/README.md +++ b/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: diff --git a/plugins/cost-insights/README.md b/plugins/cost-insights/README.md index 91f717dfaa..67c031edd4 100644 --- a/plugins/cost-insights/README.md +++ b/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 diff --git a/plugins/cost-insights/contrib/aws-cost-explorer-api.md b/plugins/cost-insights/contrib/aws-cost-explorer-api.md index d6c5250759..caa7b72e10 100644 --- a/plugins/cost-insights/contrib/aws-cost-explorer-api.md +++ b/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 diff --git a/plugins/firehydrant/README.md b/plugins/firehydrant/README.md index aaab8b7d0e..d7169e08f0 100644 --- a/plugins/firehydrant/README.md +++ b/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 `` component: diff --git a/plugins/fossa/README.md b/plugins/fossa/README.md index 6ca2e1a96f..898c9d0475 100644 --- a/plugins/fossa/README.md +++ b/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: diff --git a/plugins/github-actions/README.md b/plugins/github-actions/README.md index c55bb260a8..792d13280f 100644 --- a/plugins/github-actions/README.md +++ b/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: diff --git a/plugins/github-deployments/README.md b/plugins/github-deployments/README.md index 3c5435b4a6..5cc6ccdeaa 100644 --- a/plugins/github-deployments/README.md +++ b/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: diff --git a/plugins/graphiql/README.md b/plugins/graphiql/README.md index b95f055a56..452dfa807d 100644 --- a/plugins/graphiql/README.md +++ b/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 diff --git a/plugins/home/README.md b/plugins/home/README.md index b3b492be8e..a85994b3cb 100644 --- a/plugins/home/README.md +++ b/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 diff --git a/plugins/ilert/README.md b/plugins/ilert/README.md index da019d6bb6..c704108126 100644 --- a/plugins/ilert/README.md +++ b/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`: diff --git a/plugins/jenkins-backend/README.md b/plugins/jenkins-backend/README.md index d10edc3e69..5fd3416e42 100644 --- a/plugins/jenkins-backend/README.md +++ b/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` diff --git a/plugins/jenkins/README.md b/plugins/jenkins/README.md index 2012555d93..80e39d2095 100644 --- a/plugins/jenkins/README.md +++ b/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 diff --git a/plugins/lighthouse/README.md b/plugins/lighthouse/README.md index 06c9a1da12..f07041d9ff 100644 --- a/plugins/lighthouse/README.md +++ b/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: diff --git a/plugins/pagerduty/README.md b/plugins/pagerduty/README.md index 923610db5e..71050dc54b 100644 --- a/plugins/pagerduty/README.md +++ b/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 diff --git a/plugins/periskop/README.md b/plugins/periskop/README.md index 35e86f083d..192948402a 100644 --- a/plugins/periskop/README.md +++ b/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: diff --git a/plugins/rollbar/README.md b/plugins/rollbar/README.md index bdf0541fa0..99a3deb763 100644 --- a/plugins/rollbar/README.md +++ b/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: diff --git a/plugins/scaffolder-backend-module-cookiecutter/README.md b/plugins/scaffolder-backend-module-cookiecutter/README.md index efbe9e2a22..642ef25edf 100644 --- a/plugins/scaffolder-backend-module-cookiecutter/README.md +++ b/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: diff --git a/plugins/scaffolder-backend-module-rails/README.md b/plugins/scaffolder-backend-module-rails/README.md index 7fcd298b42..182f741845 100644 --- a/plugins/scaffolder-backend-module-rails/README.md +++ b/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 diff --git a/plugins/scaffolder-backend-module-yeoman/README.md b/plugins/scaffolder-backend-module-yeoman/README.md index 64be671145..8ad3a74fe2 100644 --- a/plugins/scaffolder-backend-module-yeoman/README.md +++ b/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: diff --git a/plugins/scaffolder-backend/README.md b/plugins/scaffolder-backend/README.md index 7efe33f7f6..6a29911e13 100644 --- a/plugins/scaffolder-backend/README.md +++ b/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` diff --git a/plugins/scaffolder/README.md b/plugins/scaffolder/README.md index 0bfd2f8a35..b74c03ec34 100644 --- a/plugins/scaffolder/README.md +++ b/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` diff --git a/plugins/sentry/README.md b/plugins/sentry/README.md index 073bac1208..7cc015eb13 100644 --- a/plugins/sentry/README.md +++ b/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: diff --git a/plugins/sonarqube/README.md b/plugins/sonarqube/README.md index 2652e156f8..febce4ecfc 100644 --- a/plugins/sonarqube/README.md +++ b/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: diff --git a/plugins/splunk-on-call/README.md b/plugins/splunk-on-call/README.md index 5078dfa38b..fd14b311c6 100644 --- a/plugins/splunk-on-call/README.md +++ b/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`: diff --git a/plugins/tech-insights-backend-module-jsonfc/README.md b/plugins/tech-insights-backend-module-jsonfc/README.md index c7a018c5fc..70b2ef2c40 100644 --- a/plugins/tech-insights-backend-module-jsonfc/README.md +++ b/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. diff --git a/plugins/tech-insights-backend/README.md b/plugins/tech-insights-backend/README.md index 324ea59f88..ee6ef4c0cc 100644 --- a/plugins/tech-insights-backend/README.md +++ b/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. diff --git a/plugins/tech-insights/README.md b/plugins/tech-insights/README.md index 068f88c035..5f7d7ad4e5 100644 --- a/plugins/tech-insights/README.md +++ b/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: diff --git a/plugins/tech-radar/README.md b/plugins/tech-radar/README.md index 6f89b93688..10c7a104c1 100644 --- a/plugins/tech-radar/README.md +++ b/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