From 1145181834f58328fc846c6776fdb8ff26c1d79f Mon Sep 17 00:00:00 2001 From: Andre Wanlin Date: Sat, 13 Jul 2024 10:45:17 -0500 Subject: [PATCH] Moved from root note to title Signed-off-by: Andre Wanlin --- docs/auth/guest/provider.md | 3 +-- docs/features/kubernetes/authenticationstrategy.md | 3 +-- docs/features/kubernetes/installation.md | 9 +++------ docs/features/search/getting-started.md | 6 ++---- docs/features/software-catalog/configuration.md | 6 ++---- docs/features/software-templates/builtin-actions.md | 3 +-- docs/features/techdocs/getting-started.md | 9 +++------ docs/getting-started/config/database.md | 3 +-- docs/getting-started/configure-app-with-plugins.md | 3 +-- docs/getting-started/homepage.md | 3 +-- docs/integrations/aws-s3/discovery--old.md | 3 +-- docs/integrations/aws-s3/discovery.md | 3 +-- docs/integrations/azure/discovery--old.md | 3 +-- docs/integrations/azure/discovery.md | 3 +-- docs/integrations/azure/org--old.md | 3 +-- docs/integrations/azure/org.md | 3 +-- docs/integrations/bitbucketCloud/discovery.md | 3 +-- docs/integrations/bitbucketServer/discovery.md | 3 +-- docs/integrations/gerrit/discovery.md | 3 +-- docs/integrations/github/discovery--old.md | 6 ++---- docs/integrations/github/discovery.md | 3 +-- docs/integrations/github/org--old.md | 6 ++---- docs/integrations/github/org.md | 3 +-- docs/integrations/gitlab/discovery.md | 3 +-- docs/integrations/gitlab/org.md | 3 +-- docs/integrations/ldap/org--old.md | 3 +-- docs/integrations/ldap/org.md | 3 +-- docs/permissions/getting-started.md | 3 +-- docs/permissions/plugin-authors/01-setup.md | 3 +-- docs/plugins/backend-plugin.md | 3 +-- docs/releases/v1.6.0-changelog.md | 6 ++---- docs/releases/v1.6.0-next.0-changelog.md | 6 ++---- docs/tutorials/configuring-plugin-databases.md | 13 ++++++++----- docs/tutorials/switching-sqlite-postgres.md | 3 +-- 34 files changed, 51 insertions(+), 91 deletions(-) diff --git a/docs/auth/guest/provider.md b/docs/auth/guest/provider.md index b28274d2ba..b541178571 100644 --- a/docs/auth/guest/provider.md +++ b/docs/auth/guest/provider.md @@ -25,8 +25,7 @@ This will only work with the new backend system. There is no support for this in Add the `@backstage/plugin-auth-backend-module-guest-provider` to your backend installation. -```sh -# From your Backstage root directory +```sh title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-auth-backend-module-guest-provider ``` diff --git a/docs/features/kubernetes/authenticationstrategy.md b/docs/features/kubernetes/authenticationstrategy.md index a7d093248a..ffea69d610 100644 --- a/docs/features/kubernetes/authenticationstrategy.md +++ b/docs/features/kubernetes/authenticationstrategy.md @@ -173,8 +173,7 @@ To create the Backend module, run `yarn new`, select `backend-module`. Then fill This will create a new package at `plugins/kubernetes-backend-module-pinniped`. We are going to need also the `@backstage/plugin-kubernetes-node` and `@backstage/plugin-kubernetes-common` dependencies, the `@backstage/plugin-kubernetes-node` houses the [kubernetesAuthStrategyExtensionPoint](https://github.com/backstage/backstage/blob/ebe7afad9d19f279469168ca0d4feceb92c1ad36/plugins/kubernetes-node/src/extensions.ts#L77) and a [Pinniped Helper](https://github.com/backstage/backstage/blob/ebe7afad9d19f279469168ca0d4feceb92c1ad36/plugins/kubernetes-node/src/auth/PinnipedHelper.ts#L53) class. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd plugins/kubernetes-backend-module-pinniped add @backstage/plugin-kubernetes-node yarn --cwd plugins/kubernetes-backend-module-pinniped add @backstage/plugin-kubernetes-common ``` diff --git a/docs/features/kubernetes/installation.md b/docs/features/kubernetes/installation.md index b3d03cc0b4..279c9cbf3f 100644 --- a/docs/features/kubernetes/installation.md +++ b/docs/features/kubernetes/installation.md @@ -15,8 +15,7 @@ If you haven't setup Backstage already, read the The first step is to add the Kubernetes frontend plugin to your Backstage application. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/app add @backstage/plugin-kubernetes ``` @@ -53,8 +52,7 @@ work. Navigate to `packages/backend` of your Backstage app, and install the `@backstage/plugin-kubernetes-backend` package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-kubernetes-backend ``` @@ -109,8 +107,7 @@ To get the Kubernetes plugin install using the New Backend System you will need Run this command to add the package: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-kubernetes-backend ``` diff --git a/docs/features/search/getting-started.md b/docs/features/search/getting-started.md index 7989b60ae2..b2a074974f 100644 --- a/docs/features/search/getting-started.md +++ b/docs/features/search/getting-started.md @@ -16,8 +16,7 @@ If you haven't setup Backstage already, start ## Adding Search to the Frontend -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/app add @backstage/plugin-search @backstage/plugin-search-react ``` @@ -133,8 +132,7 @@ For more information about using `Root.tsx`, please see Add the following plugins into your backend app: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-search-backend @backstage/plugin-search-backend-node ``` diff --git a/docs/features/software-catalog/configuration.md b/docs/features/software-catalog/configuration.md index f5df9eafca..17d5f49205 100644 --- a/docs/features/software-catalog/configuration.md +++ b/docs/features/software-catalog/configuration.md @@ -184,8 +184,7 @@ Catalog errors are published to the [events plugin](https://github.com/backstage The first step is to add the events backend plugin to your Backstage application. Navigate to your Backstage application directory and add the plugin package. -```ts -# From your Backstage root directory +```ts title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-events-backend ``` @@ -201,8 +200,7 @@ If you want to log catalog errors you can install the `@backstage/plugin-catalog Install the catalog logs module. -```ts -# From your Backstage root directory +```ts title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-logs ``` diff --git a/docs/features/software-templates/builtin-actions.md b/docs/features/software-templates/builtin-actions.md index 5b1e4347da..301fb4c457 100644 --- a/docs/features/software-templates/builtin-actions.md +++ b/docs/features/software-templates/builtin-actions.md @@ -24,8 +24,7 @@ There are also several modules available for various SCM tools: Here's how to add an action module, first you need to run this command: -```sh -# From your Backstage root directory +```sh title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend-module-github ``` diff --git a/docs/features/techdocs/getting-started.md b/docs/features/techdocs/getting-started.md index 7909f8166f..a157d29c0d 100644 --- a/docs/features/techdocs/getting-started.md +++ b/docs/features/techdocs/getting-started.md @@ -21,8 +21,7 @@ The first step is to add the TechDocs plugin to your Backstage application. Navigate to your new Backstage application directory. And then to your `packages/app` directory, and install the `@backstage/plugin-techdocs` package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/app add @backstage/plugin-techdocs ``` @@ -106,8 +105,7 @@ That's it! Now, we need the TechDocs Backend plugin for the frontend to work. Navigate to `packages/backend` of your Backstage app, and install the `@backstage/plugin-techdocs-backend` package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-techdocs-backend ``` @@ -199,8 +197,7 @@ To install TechDocs when using the New Backend system you will need to do the fo Navigate to `packages/backend` of your Backstage app, and install the `@backstage/plugin-techdocs-backend` package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-techdocs-backend ``` diff --git a/docs/getting-started/config/database.md b/docs/getting-started/config/database.md index a560fe507b..0fbd66d5a3 100644 --- a/docs/getting-started/config/database.md +++ b/docs/getting-started/config/database.md @@ -73,8 +73,7 @@ to install and configure the client. Go to the root directory of your freshly installed Backstage App. Run the following to install the PostgreSQL client into your backend: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add pg ``` diff --git a/docs/getting-started/configure-app-with-plugins.md b/docs/getting-started/configure-app-with-plugins.md index 2fdb016e7b..95fd456dc0 100644 --- a/docs/getting-started/configure-app-with-plugins.md +++ b/docs/getting-started/configure-app-with-plugins.md @@ -21,8 +21,7 @@ to an entity in the software catalog. 1. Add the plugin's npm package to the repo: - ```bash - # From your Backstage root directory + ```bash title="From your Backstage root directory" yarn --cwd packages/app add @circleci/backstage-plugin ``` diff --git a/docs/getting-started/homepage.md b/docs/getting-started/homepage.md index 7e1a2ed909..d7c9b46faa 100644 --- a/docs/getting-started/homepage.md +++ b/docs/getting-started/homepage.md @@ -28,8 +28,7 @@ Now, let's get started by installing the home plugin and creating a simple homep #### 1. Install the plugin -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/app add @backstage/plugin-home ``` diff --git a/docs/integrations/aws-s3/discovery--old.md b/docs/integrations/aws-s3/discovery--old.md index bff63af9e5..09b6eb6cc0 100644 --- a/docs/integrations/aws-s3/discovery--old.md +++ b/docs/integrations/aws-s3/discovery--old.md @@ -66,8 +66,7 @@ catalog: As this provider is not one of the default providers, you will first need to install the AWS catalog plugin: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-aws ``` diff --git a/docs/integrations/aws-s3/discovery.md b/docs/integrations/aws-s3/discovery.md index cce410ea8b..db9119680e 100644 --- a/docs/integrations/aws-s3/discovery.md +++ b/docs/integrations/aws-s3/discovery.md @@ -66,8 +66,7 @@ catalog: As this provider is not one of the default providers, you will first need to install the AWS catalog plugin: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-aws ``` diff --git a/docs/integrations/azure/discovery--old.md b/docs/integrations/azure/discovery--old.md index be490d70fe..56a2fe559f 100644 --- a/docs/integrations/azure/discovery--old.md +++ b/docs/integrations/azure/discovery--old.md @@ -102,8 +102,7 @@ It may take some time before the branch is indexed and searchable. As this provider is not one of the default providers, you will first need to install the Azure catalog plugin: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-azure ``` diff --git a/docs/integrations/azure/discovery.md b/docs/integrations/azure/discovery.md index 7e7b465118..c8a8a3af7c 100644 --- a/docs/integrations/azure/discovery.md +++ b/docs/integrations/azure/discovery.md @@ -102,8 +102,7 @@ It may take some time before the branch is indexed and searchable. As this provider is not one of the default providers, you will first need to install the Azure catalog plugin: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-azure ``` diff --git a/docs/integrations/azure/org--old.md b/docs/integrations/azure/org--old.md index 13d53b24b3..899120e88a 100644 --- a/docs/integrations/azure/org--old.md +++ b/docs/integrations/azure/org--old.md @@ -18,8 +18,7 @@ Microsoft Graph API. The package is not installed by default, therefore you have to add `@backstage/plugin-catalog-backend-module-msgraph` to your backend package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-msgraph ``` diff --git a/docs/integrations/azure/org.md b/docs/integrations/azure/org.md index 2dfdee7bce..0a4eda2db5 100644 --- a/docs/integrations/azure/org.md +++ b/docs/integrations/azure/org.md @@ -18,8 +18,7 @@ Microsoft Graph API. The package is not installed by default, therefore you have to add `@backstage/plugin-catalog-backend-module-msgraph` to your backend package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-msgraph ``` diff --git a/docs/integrations/bitbucketCloud/discovery.md b/docs/integrations/bitbucketCloud/discovery.md index 160827cb0a..04dc111d30 100644 --- a/docs/integrations/bitbucketCloud/discovery.md +++ b/docs/integrations/bitbucketCloud/discovery.md @@ -19,8 +19,7 @@ backend. The provider is not installed by default, therefore you have to add a dependency to `@backstage/plugin-catalog-backend-module-bitbucket-cloud` to your backend package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-bitbucket-cloud ``` diff --git a/docs/integrations/bitbucketServer/discovery.md b/docs/integrations/bitbucketServer/discovery.md index d9fc946460..99e04affa8 100644 --- a/docs/integrations/bitbucketServer/discovery.md +++ b/docs/integrations/bitbucketServer/discovery.md @@ -19,8 +19,7 @@ backend. The provider is not installed by default, therefore you have to add a dependency to `@backstage/plugin-catalog-backend-module-bitbucket-server` to your backend package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-bitbucket-server ``` diff --git a/docs/integrations/gerrit/discovery.md b/docs/integrations/gerrit/discovery.md index e2922c1f76..96dfbd47fb 100644 --- a/docs/integrations/gerrit/discovery.md +++ b/docs/integrations/gerrit/discovery.md @@ -16,8 +16,7 @@ stored in the root of the matching projects. As this provider is not one of the default providers, you will first need to install the Gerrit provider plugin: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-gerrit ``` diff --git a/docs/integrations/github/discovery--old.md b/docs/integrations/github/discovery--old.md index 138e54a538..752aa51bde 100644 --- a/docs/integrations/github/discovery--old.md +++ b/docs/integrations/github/discovery--old.md @@ -25,8 +25,7 @@ backend. They are not installed by default, therefore you have to add a dependency on `@backstage/plugin-catalog-backend-module-github` to your backend package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github ``` @@ -273,8 +272,7 @@ backend. They are not installed by default, therefore you have to add a dependency on `@backstage/plugin-catalog-backend-module-github` to your backend package, plus `@backstage/integration` for the basic credentials management: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/integration @backstage/plugin-catalog-backend-module-github ``` diff --git a/docs/integrations/github/discovery.md b/docs/integrations/github/discovery.md index d8374932b8..43e63a618c 100644 --- a/docs/integrations/github/discovery.md +++ b/docs/integrations/github/discovery.md @@ -24,8 +24,7 @@ You will have to add the GitHub Entity provider to your backend as it is not ins dependency on `@backstage/plugin-catalog-backend-module-github` to your backend package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github ``` diff --git a/docs/integrations/github/org--old.md b/docs/integrations/github/org--old.md index 3d1639a924..bf12cad036 100644 --- a/docs/integrations/github/org--old.md +++ b/docs/integrations/github/org--old.md @@ -29,8 +29,7 @@ the Processor method (not recommended), it is described separately below. The provider is not installed by default, therefore you have to add a dependency to `@backstage/plugin-catalog-backend-module-github` to your backend package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github ``` @@ -334,8 +333,7 @@ frequency with which they are refreshed, separately from other processors. The `GithubOrgReaderProcessor` is not registered by default, so you have to install and register it in the catalog plugin: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github ``` diff --git a/docs/integrations/github/org.md b/docs/integrations/github/org.md index f94ffe6c7a..18865cd630 100644 --- a/docs/integrations/github/org.md +++ b/docs/integrations/github/org.md @@ -38,8 +38,7 @@ You will have to add the GitHub Org provider to your backend as it is not instal dependency on `@backstage/plugin-catalog-backend-module-github-org` to your backend package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github-org ``` diff --git a/docs/integrations/gitlab/discovery.md b/docs/integrations/gitlab/discovery.md index 98fbb0fbce..13ffd79801 100644 --- a/docs/integrations/gitlab/discovery.md +++ b/docs/integrations/gitlab/discovery.md @@ -20,8 +20,7 @@ This provider can also be configured to ingest GitLab data based on [GitLab Webh As this provider is not one of the default providers, you will first need to install the gitlab catalog plugin: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-gitlab ``` diff --git a/docs/integrations/gitlab/org.md b/docs/integrations/gitlab/org.md index 46d720c164..65f66aa763 100644 --- a/docs/integrations/gitlab/org.md +++ b/docs/integrations/gitlab/org.md @@ -25,8 +25,7 @@ This provider can also be configured to ingest GitLab data based on [GitLab Syst As this provider is not one of the default providers, you will first need to install the Gitlab provider plugin: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-gitlab @backstage/plugin-catalog-backend-module-gitlab-org ``` diff --git a/docs/integrations/ldap/org--old.md b/docs/integrations/ldap/org--old.md index 63f052371f..448e9bbed1 100644 --- a/docs/integrations/ldap/org--old.md +++ b/docs/integrations/ldap/org--old.md @@ -24,8 +24,7 @@ the Processor method (not recommended), it is described separately below. The provider is not installed by default, therefore you have to add a dependency to `@backstage/plugin-catalog-backend-module-ldap` to your backend package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-ldap ``` diff --git a/docs/integrations/ldap/org.md b/docs/integrations/ldap/org.md index 36cffb9b1f..b1aa460bd6 100644 --- a/docs/integrations/ldap/org.md +++ b/docs/integrations/ldap/org.md @@ -21,8 +21,7 @@ Backstage in general supports OpenLDAP compatible vendors, as well as Active Dir The provider is not installed by default, therefore you have to add a dependency to `@backstage/plugin-catalog-backend-module-ldap` to your backend package. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-ldap ``` diff --git a/docs/permissions/getting-started.md b/docs/permissions/getting-started.md index 4dabf3fcbd..e8132e571b 100644 --- a/docs/permissions/getting-started.md +++ b/docs/permissions/getting-started.md @@ -50,8 +50,7 @@ The permissions framework uses a new `permission-backend` plugin to accept autho 1. Add `@backstage/plugin-permission-backend` as a dependency of your Backstage backend: - ```bash - # From your Backstage root directory + ```bash title="From your Backstage root directory" yarn --cwd packages/backend add @backstage/plugin-permission-backend ``` diff --git a/docs/permissions/plugin-authors/01-setup.md b/docs/permissions/plugin-authors/01-setup.md index a674d82e25..f11bdff930 100644 --- a/docs/permissions/plugin-authors/01-setup.md +++ b/docs/permissions/plugin-authors/01-setup.md @@ -39,8 +39,7 @@ The source code is available here: 2. Add these packages as dependencies for your Backstage app: - ```sh - # From your Backstage root directory + ```sh title="From your Backstage root directory" yarn --cwd packages/backend add @internal/plugin-todo-list-backend @internal/plugin-todo-list-common yarn --cwd packages/app add @internal/plugin-todo-list ``` diff --git a/docs/plugins/backend-plugin.md b/docs/plugins/backend-plugin.md index 7f155f3b05..1366a59099 100644 --- a/docs/plugins/backend-plugin.md +++ b/docs/plugins/backend-plugin.md @@ -71,8 +71,7 @@ Backstage application / backend exposes it. To actually attach and run the plugin router, you will make some modifications to your backend. -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add @internal/plugin-carmen-backend@^0.1.0 # Change this to match the plugin's package.json ``` diff --git a/docs/releases/v1.6.0-changelog.md b/docs/releases/v1.6.0-changelog.md index 0532243cbf..e9692f4f1b 100644 --- a/docs/releases/v1.6.0-changelog.md +++ b/docs/releases/v1.6.0-changelog.md @@ -248,8 +248,7 @@ 1. First we need to add the @backstage/plugin-azure-devops package to your frontend app: - ```bash - # From your Backstage root directory + ```bash title="From your Backstage root directory" yarn add --cwd packages/app @backstage/plugin-azure-devops ``` @@ -313,8 +312,7 @@ 1. First we need to add the @backstage/plugin-azure-devops package to your frontend app: - ```bash - # From your Backstage root directory + ```bash title="From your Backstage root directory" yarn add --cwd packages/app @backstage/plugin-azure-devops ``` diff --git a/docs/releases/v1.6.0-next.0-changelog.md b/docs/releases/v1.6.0-next.0-changelog.md index 5ff2311b79..fbe9caefde 100644 --- a/docs/releases/v1.6.0-next.0-changelog.md +++ b/docs/releases/v1.6.0-next.0-changelog.md @@ -10,8 +10,7 @@ 1. First we need to add the @backstage/plugin-azure-devops package to your frontend app: - ```bash - # From your Backstage root directory + ```bash title="From your Backstage root directory" yarn add --cwd packages/app @backstage/plugin-azure-devops ``` @@ -69,8 +68,7 @@ 1. First we need to add the @backstage/plugin-azure-devops package to your frontend app: - ```bash - # From your Backstage root directory + ```bash title="From your Backstage root directory" yarn add --cwd packages/app @backstage/plugin-azure-devops ``` diff --git a/docs/tutorials/configuring-plugin-databases.md b/docs/tutorials/configuring-plugin-databases.md index 528d2c6325..db3f126de7 100644 --- a/docs/tutorials/configuring-plugin-databases.md +++ b/docs/tutorials/configuring-plugin-databases.md @@ -36,12 +36,15 @@ Please ensure the appropriate database drivers are installed in your `backend` package. If you intend to use both PostgreSQL and SQLite, you can install both of them. -```bash -# From your Backstage root directory -# install pg if you need PostgreSQL -yarn --cwd packages/backend add pg +Install pg if you need PostgreSQL: -# install SQLite 3 if you intend to set it as the client +```bash title="From your Backstage root directory" +yarn --cwd packages/backend add pg +``` + +Install SQLite 3 if you intend to set it as the client: + +```bash title="From your Backstage root directory" yarn --cwd packages/backend add better-sqlite3 ``` diff --git a/docs/tutorials/switching-sqlite-postgres.md b/docs/tutorials/switching-sqlite-postgres.md index 2ef481dbf3..aec9ca2ee9 100644 --- a/docs/tutorials/switching-sqlite-postgres.md +++ b/docs/tutorials/switching-sqlite-postgres.md @@ -19,8 +19,7 @@ switch between database backends. First, add PostgreSQL to your `backend` package: -```bash -# From your Backstage root directory +```bash title="From your Backstage root directory" yarn --cwd packages/backend add pg ```