From 933fe2c34447095c6b8e26aa667a290cbefd3f98 Mon Sep 17 00:00:00 2001 From: Sergey Shevchenko Date: Wed, 17 May 2023 11:30:06 +0300 Subject: [PATCH] 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