diff --git a/docs/features/software-catalog/extending-the-model--old.md b/docs/features/software-catalog/extending-the-model--old.md index 7368a4a339..668d1d8311 100644 --- a/docs/features/software-catalog/extending-the-model--old.md +++ b/docs/features/software-catalog/extending-the-model--old.md @@ -495,8 +495,8 @@ want to have an isomorphic package that houses these types. Within the Backstage main repo the package naming pattern of `-common` is used for isomorphic packages, and you may choose to adopt this pattern as well. -You can generate an isomorphic plugin package by running:`yarn new --select plugin-common` -or you can run `yarn new` and then select "plugin-common" from the list of options +You can generate an isomorphic plugin package by running: `yarn new` and then +select "plugin-common" from the list of options There's at this point no existing templates for generating isomorphic plugins using the `@backstage/cli`. Perhaps the simplest way to get started right now is diff --git a/docs/features/software-catalog/extending-the-model.md b/docs/features/software-catalog/extending-the-model.md index f9d20d03c2..d289886a09 100644 --- a/docs/features/software-catalog/extending-the-model.md +++ b/docs/features/software-catalog/extending-the-model.md @@ -495,8 +495,8 @@ want to have an isomorphic package that houses these types. Within the Backstage main repo the package naming pattern of `-common` is used for isomorphic packages, and you may choose to adopt this pattern as well. -You can generate an isomorphic plugin package by running:`yarn new --select plugin-common` -or you can run `yarn new` and then select "plugin-common" from the list of options +You can generate an isomorphic plugin package by running: `yarn new` and then +selecting "plugin-common" from the list of options There's at this point no existing templates for generating isomorphic plugins using the `@backstage/cli`. Perhaps the simplest way to get started right now is @@ -520,7 +520,7 @@ validate entities of our new kind. Just like with the definition package, you can find inspiration in for example the existing [ScaffolderEntitiesProcessor](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend-module-scaffolder-entity-model/src/processor/ScaffolderEntitiesProcessor.ts). -The custom processor should be created as a separate module for the catalog plugin. For information on how to set that up, see the [plugin docs](../../plugins/backend-plugin.md#creating-a-backend-plugin). Use `yarn new --select backend-module` instead to create a module. For our case, the module ID will be `foobar` and the plugin ID will be `catalog`. +The custom processor should be created as a separate module for the catalog plugin. For information on how to set that up, see the [plugin docs](../../plugins/backend-plugin.md#creating-a-backend-plugin). Use `yarn new` and select `backend-module` instead to create a module. For our case, the module ID will be `foobar` and the plugin ID will be `catalog`. We also provide a high-level example of what a catalog process for a custom entity might look like: diff --git a/docs/features/software-catalog/external-integrations.md b/docs/features/software-catalog/external-integrations.md index f721c50ec2..48b8fc6ab5 100644 --- a/docs/features/software-catalog/external-integrations.md +++ b/docs/features/software-catalog/external-integrations.md @@ -72,9 +72,11 @@ putting all extensions like this in a backend module package of their own in the `plugins` folder of your Backstage repo: ```sh -yarn new --select backend-module --option id=catalog +yarn new ``` +Select `backend-module` and enter `catalog` for the id. + The class will have this basic structure: ```ts title="plugins/catalog-backend-module-frobs/src/FrobsProvider.ts" @@ -650,9 +652,11 @@ putting all extensions like this in a backend module package of their own in the `plugins` folder of your Backstage repo: ```sh -yarn new --select backend-module --option id=catalog +yarn new ``` +Select `backend-module` and enter `catalog` for the id. + The class will have this basic structure: ```ts diff --git a/docs/plugins/backend-plugin.md b/docs/plugins/backend-plugin.md index 1366a59099..2a69487ff8 100644 --- a/docs/plugins/backend-plugin.md +++ b/docs/plugins/backend-plugin.md @@ -10,18 +10,12 @@ Backstage repository. ## Creating a Backend Plugin A new, bare-bones backend plugin package can be created by issuing the following -command in your Backstage repository root: +command in your Backstage repository root and selecting `backend-plugin`: ```sh -yarn new --select backend-plugin +yarn backstage-cli new ``` -Please also see the `--help` flag for the `new` command for some -further options that are available, notably the `--scope` and `--no-private` -flags that control naming and publishing of the newly created package. Your repo -root `package.json` will probably also have some default values already set up -for these. - You will be asked to supply a name for the plugin. This is an identifier that will be part of the NPM package name, so make it short and containing only lowercase characters separated by dashes, for example `carmen`, if it's a diff --git a/docs/plugins/create-a-plugin.md b/docs/plugins/create-a-plugin.md index d80e9cd57e..3810495707 100644 --- a/docs/plugins/create-a-plugin.md +++ b/docs/plugins/create-a-plugin.md @@ -15,9 +15,11 @@ invoking the from the root of your project. ```bash -yarn new --select plugin +yarn new ``` +And then select `frontend-plugin`. + ![Example of output when creating a new plugin](../assets/getting-started/create-plugin_output.png) This will create a new Backstage Plugin based on the ID that was provided. It diff --git a/docs/plugins/integrating-plugin-into-software-catalog.md b/docs/plugins/integrating-plugin-into-software-catalog.md index d47be7f4c0..ed2e25c601 100644 --- a/docs/plugins/integrating-plugin-into-software-catalog.md +++ b/docs/plugins/integrating-plugin-into-software-catalog.md @@ -21,7 +21,8 @@ should have a separate package in a folder, which represents your plugin. Example: ``` -$ yarn new --select plugin +$ yarn new +# Select `frontend-plugin` > ? Enter an ID for the plugin [required] my-plugin > ? Enter the owner(s) of the plugin. If specified, this will be added to CODEOWNERS for the plugin path. [optional] diff --git a/docs/tutorials/quickstart-app-plugin.md b/docs/tutorials/quickstart-app-plugin.md index a1b30829b3..e02d2f546f 100644 --- a/docs/tutorials/quickstart-app-plugin.md +++ b/docs/tutorials/quickstart-app-plugin.md @@ -30,7 +30,7 @@ title: Adding Custom Plugin to Existing Monorepo App # The Skeleton Plugin 1. Start by using the built-in creator. From the terminal and root of your - project run: `yarn new --select plugin` + project run: `yarn new` and select `frontend-plugin`. 1. Enter a plugin ID. I used `github-playground` 1. When the process finishes, let's start the backend: `yarn --cwd packages/backend start`