From 933fe2c34447095c6b8e26aa667a290cbefd3f98 Mon Sep 17 00:00:00 2001 From: Sergey Shevchenko Date: Wed, 17 May 2023 11:30:06 +0300 Subject: [PATCH 1/5] docs: Update plugin installation commands Signed-off-by: Sergey Shevchenko --- .changeset/honest-peas-guess.md | 7 +++++++ plugins/analytics-module-ga4/README.md | 6 +++++- plugins/devtools-backend/README.md | 3 +-- plugins/linguist-backend/README.md | 3 +-- 4 files changed, 14 insertions(+), 5 deletions(-) create mode 100644 .changeset/honest-peas-guess.md diff --git a/.changeset/honest-peas-guess.md b/.changeset/honest-peas-guess.md new file mode 100644 index 0000000000..cac2330a06 --- /dev/null +++ b/.changeset/honest-peas-guess.md @@ -0,0 +1,7 @@ +--- +'@backstage/plugin-analytics-module-ga4': patch +'@backstage/plugin-devtools-backend': patch +'@backstage/plugin-linguist-backend': patch +--- + +Update plugin installation docs to be more consistent across documentations diff --git a/plugins/analytics-module-ga4/README.md b/plugins/analytics-module-ga4/README.md index d060c9d9b1..e9d227788a 100644 --- a/plugins/analytics-module-ga4/README.md +++ b/plugins/analytics-module-ga4/README.md @@ -9,7 +9,11 @@ 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 +yarn add --cwd packages/app @backstage/@backstage/plugin-analytics-module-ga4 +``` + 2. Wire up the API implementation to your App: ```tsx diff --git a/plugins/devtools-backend/README.md b/plugins/devtools-backend/README.md index e505a04963..7304ce33d7 100644 --- a/plugins/devtools-backend/README.md +++ b/plugins/devtools-backend/README.md @@ -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 diff --git a/plugins/linguist-backend/README.md b/plugins/linguist-backend/README.md index 46c067fb5a..95599d421c 100644 --- a/plugins/linguist-backend/README.md +++ b/plugins/linguist-backend/README.md @@ -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 From 662b446d3c3b14f9c267afeb6804e39247cde071 Mon Sep 17 00:00:00 2001 From: Sergey Shevchenko Date: Wed, 17 May 2023 21:57:46 +0300 Subject: [PATCH 2/5] Update plugins/analytics-module-ga4/README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fredrik Adelöw Signed-off-by: Sergey Shevchenko --- plugins/analytics-module-ga4/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/analytics-module-ga4/README.md b/plugins/analytics-module-ga4/README.md index e9d227788a..7bb8447f51 100644 --- a/plugins/analytics-module-ga4/README.md +++ b/plugins/analytics-module-ga4/README.md @@ -11,7 +11,7 @@ This plugin contains no other functionality. 1. Install the plugin package in your Backstage app: ```sh -yarn add --cwd packages/app @backstage/@backstage/plugin-analytics-module-ga4 +yarn add --cwd packages/app @backstage/plugin-analytics-module-ga4 ``` 2. Wire up the API implementation to your App: From 56575be2a26769bd18cce79f782682dede98cc06 Mon Sep 17 00:00:00 2001 From: Sergey Shevchenko Date: Thu, 18 May 2023 10:56:10 +0300 Subject: [PATCH 3/5] docs: Add notes about backstage root dir Signed-off-by: Sergey Shevchenko --- docs/integrations/github/discovery.md | 3 +-- docs/permissions/getting-started.md | 2 +- docs/permissions/plugin-authors/01-setup.md | 4 ++-- plugins/analytics-module-ga4/README.md | 1 + plugins/dynatrace/README.md | 1 + plugins/entity-validation/README.md | 1 + plugins/pagerduty/README.md | 2 +- plugins/techdocs-react/README.md | 1 + 8 files changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/integrations/github/discovery.md b/docs/integrations/github/discovery.md index 7f6cc057cd..f01085dd86 100644 --- a/docs/integrations/github/discovery.md +++ b/docs/integrations/github/discovery.md @@ -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: diff --git a/docs/permissions/getting-started.md b/docs/permissions/getting-started.md index 8cb6dd953e..01a268f7ef 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 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. diff --git a/docs/permissions/plugin-authors/01-setup.md b/docs/permissions/plugin-authors/01-setup.md index 6827096900..8134fc0c39 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 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: diff --git a/plugins/analytics-module-ga4/README.md b/plugins/analytics-module-ga4/README.md index 7bb8447f51..97bb751ca8 100644 --- a/plugins/analytics-module-ga4/README.md +++ b/plugins/analytics-module-ga4/README.md @@ -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 ``` diff --git a/plugins/dynatrace/README.md b/plugins/dynatrace/README.md index b07fe985fe..3d14be9145 100644 --- a/plugins/dynatrace/README.md +++ b/plugins/dynatrace/README.md @@ -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 ``` diff --git a/plugins/entity-validation/README.md b/plugins/entity-validation/README.md index 1f864d0857..7816262836 100644 --- a/plugins/entity-validation/README.md +++ b/plugins/entity-validation/README.md @@ -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 ``` diff --git a/plugins/pagerduty/README.md b/plugins/pagerduty/README.md index ac3ba529dd..2affe1c423 100644 --- a/plugins/pagerduty/README.md +++ b/plugins/pagerduty/README.md @@ -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 ``` diff --git a/plugins/techdocs-react/README.md b/plugins/techdocs-react/README.md index 548ba8be5a..53e9fc6a3a 100644 --- a/plugins/techdocs-react/README.md +++ b/plugins/techdocs-react/README.md @@ -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 ``` From 2a0945cc39b033d10d5fc6b959d983d4d2bc8fe0 Mon Sep 17 00:00:00 2001 From: Sergey Shevchenko Date: Thu, 18 May 2023 10:59:49 +0300 Subject: [PATCH 4/5] docs: Update changeset Signed-off-by: Sergey Shevchenko --- .changeset/wise-ties-thank.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .changeset/wise-ties-thank.md diff --git a/.changeset/wise-ties-thank.md b/.changeset/wise-ties-thank.md new file mode 100644 index 0000000000..ce3ce84ad7 --- /dev/null +++ b/.changeset/wise-ties-thank.md @@ -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 From 3d11596a72b5749923d4f8d9e6b1db626a416831 Mon Sep 17 00:00:00 2001 From: Sergey Shevchenko Date: Fri, 19 May 2023 14:28:58 +0300 Subject: [PATCH 5/5] fix: Fix changesets Signed-off-by: Sergey Shevchenko --- .changeset/honest-peas-guess.md | 7 ------- .changeset/{wise-ties-thank.md => yellow-crews-float.md} | 0 2 files changed, 7 deletions(-) delete mode 100644 .changeset/honest-peas-guess.md rename .changeset/{wise-ties-thank.md => yellow-crews-float.md} (100%) diff --git a/.changeset/honest-peas-guess.md b/.changeset/honest-peas-guess.md deleted file mode 100644 index cac2330a06..0000000000 --- a/.changeset/honest-peas-guess.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -'@backstage/plugin-analytics-module-ga4': patch -'@backstage/plugin-devtools-backend': patch -'@backstage/plugin-linguist-backend': patch ---- - -Update plugin installation docs to be more consistent across documentations diff --git a/.changeset/wise-ties-thank.md b/.changeset/yellow-crews-float.md similarity index 100% rename from .changeset/wise-ties-thank.md rename to .changeset/yellow-crews-float.md