move cwd as the first argument to yarn
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
@@ -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
|
||||
@@ -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`:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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`:
|
||||
|
||||
@@ -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`:
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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`:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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"
|
||||
|
||||
@@ -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`:
|
||||
|
||||
@@ -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`:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -102,7 +102,7 @@ Install in your app’s package folder (`<root>/packages/app`) with:
|
||||
|
||||
```bash
|
||||
# From your Backstage root directory
|
||||
yarn add --cwd packages/app @backstage/plugin-<plugin-name>
|
||||
yarn --cwd packages/app add @backstage/plugin-<plugin-name>
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -8,7 +8,7 @@ Add the library to your backend plugin or module package:
|
||||
|
||||
```bash
|
||||
# From your Backstage root directory
|
||||
yarn add --cwd plugins/<plugin>-backend @backstage/backend-dev-utils
|
||||
yarn --cwd plugins/<plugin>-backend add @backstage/backend-dev-utils
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
@@ -8,7 +8,7 @@ Add the library to your backend plugin or module package:
|
||||
|
||||
```bash
|
||||
# From your Backstage root directory
|
||||
yarn add --cwd plugins/<plugin>-backend @backstage/backend-plugin-api
|
||||
yarn --cwd plugins/<plugin>-backend add @backstage/backend-plugin-api
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -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`:
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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 `<FlatRoutes>` component:
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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`:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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"
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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`:
|
||||
|
||||
@@ -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`:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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 `<Grid>` component:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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`:
|
||||
|
||||
@@ -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`
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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/`:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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`.
|
||||
|
||||
@@ -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`:
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user