Merge pull request #17836 from sergeyshevch/docs/update-plugin-installation-commands

docs: Update plugin installation commands
This commit is contained in:
Fredrik Adelöw
2023-05-22 14:40:04 +02:00
committed by GitHub
11 changed files with 27 additions and 11 deletions
+11
View File
@@ -0,0 +1,11 @@
---
'@backstage/plugin-analytics-module-ga4': patch
'@backstage/plugin-entity-validation': patch
'@backstage/plugin-devtools-backend': patch
'@backstage/plugin-linguist-backend': patch
'@backstage/plugin-techdocs-react': patch
'@backstage/plugin-dynatrace': patch
'@backstage/plugin-pagerduty': patch
---
Update plugin installation docs to be more consistent across documentations
+1 -2
View File
@@ -263,8 +263,7 @@ package, plus `@backstage/integration` for the basic credentials management:
```bash
# From your Backstage root directory
yarn add --cwd packages/backend @backstage/integration
yarn add --cwd packages/backend @backstage/plugin-catalog-backend-module-github
yarn add --cwd packages/backend @backstage/integration @backstage/plugin-catalog-backend-module-github
```
And then add the processors to your catalog builder:
+1 -1
View File
@@ -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 add --cwd packages/backend @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.
+2 -2
View File
@@ -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 add --cwd packages/backend @internal/plugin-todo-list-backend @internal/plugin-todo-list-common
yarn add --cwd packages/app @internal/plugin-todo-list
```
3. Include the backend and frontend plugin in your application:
+6 -1
View File
@@ -9,7 +9,12 @@ This plugin contains no other functionality.
## Installation
1. Install the plugin package in your Backstage app:
`cd packages/app && yarn add @backstage/plugin-analytics-module-ga4`
```sh
# From your Backstage root directory
yarn add --cwd packages/app @backstage/plugin-analytics-module-ga4
```
2. Wire up the API implementation to your App:
```tsx
+1 -2
View File
@@ -10,8 +10,7 @@ Here's how to get the DevTools Backend up and running:
```sh
# From the Backstage root directory
cd packages/backend
yarn add @backstage/plugin-devtools-backend
yarn add --cwd packages/backend @backstage/plugin-devtools-backend
```
2. Then we will create a new file named `packages/backend/src/plugins/devtools.ts`, and add the
+1
View File
@@ -26,6 +26,7 @@ The Dynatrace plugin will require the following information, to be used in the c
1. Install the plugin on your frontend:
```
# From your Backstage root directory
yarn add --cwd packages/app @backstage/plugin-dynatrace
```
+1
View File
@@ -9,6 +9,7 @@ This plugin creates a new page in Backstage where the user can validate the enti
First of all, install the package in the `app` package by running the following command:
```bash
# From your Backstage root directory
yarn add --cwd packages/app @backstage/plugin-entity-validation
```
+1 -2
View File
@@ -14,8 +14,7 @@ Here's how to get the backend up and running:
```sh
# From the Backstage root directory
cd packages/backend
yarn add @backstage/plugin-linguist-backend
yarn add --cwd packages/backend @backstage/plugin-linguist-backend
```
2. Then we will create a new file named `packages/backend/src/plugins/linguist.ts`, and add the
+1 -1
View File
@@ -42,7 +42,7 @@ The file paths mentioned in the following steps are relative to your app's root
First, install the PagerDuty plugin via a CLI:
```bash
# From your Backstage app root directory
# From your Backstage root directory
yarn add --cwd packages/app @backstage/plugin-pagerduty
```
+1
View File
@@ -5,5 +5,6 @@ This package provides frontend utilities for TechDocs and Addons.
## Installation
```sh
# From your Backstage root directory
yarn add --cwd packages/app @backstage/plugin-techdocs-react
```