docs: Add notes about backstage root dir

Signed-off-by: Sergey Shevchenko <sergeyshevchdevelop@gmail.com>
This commit is contained in:
Sergey Shevchenko
2023-05-18 10:56:10 +03:00
parent 662b446d3c
commit 56575be2a2
8 changed files with 9 additions and 6 deletions
+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:
+1
View File
@@ -11,6 +11,7 @@ This plugin contains no other functionality.
1. Install the plugin package in your Backstage app:
```sh
# From your Backstage root directory
yarn add --cwd packages/app @backstage/plugin-analytics-module-ga4
```
+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 -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
```