docs: updated aroung other plugin types

Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
This commit is contained in:
Andre Wanlin
2023-09-15 14:03:22 -05:00
parent 3ab1379bb6
commit 17bf9fce0b
5 changed files with 15 additions and 4 deletions
+11 -3
View File
@@ -8,7 +8,7 @@ A Backstage Plugin adds functionality to Backstage.
## Create a Plugin
To create a new plugin, make sure you've run `yarn install` and installed
To create a new frontend plugin, make sure you've run `yarn install` and installed
dependencies, then run the following on your command line (a shortcut to
invoking the
[`backstage-cli new --select plugin`](../local-dev/cli-commands.md#new))
@@ -18,7 +18,7 @@ from the root of your project.
yarn new --select plugin
```
![](../assets/getting-started/create-plugin_output.png)
![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
will be built and added to the Backstage App automatically.
@@ -27,7 +27,7 @@ will be built and added to the Backstage App automatically.
> should be able to see the default page for your new plugin directly by
> navigating to `http://localhost:3000/my-plugin`.
![](../assets/my-plugin_screenshot.png)
![Example of new plugin running in browser](../assets/plugins/my-plugin_screenshot.png)
You can also serve the plugin in isolation by running `yarn start` in the plugin
directory. Or by using the yarn workspace command, for example:
@@ -39,3 +39,11 @@ yarn workspace @backstage/plugin-my-plugin start # Also supports --check
This method of serving the plugin provides quicker iteration speed and a faster
startup and hot reloads. It is only meant for local development, and the setup
for it can be found inside the plugin's `dev/` directory.
### Other Plugin Types
There are other plugin types that you can chose from. To be able to select the type
when you create a new plugin just run: `yarn new`. You'll then be asked what type of
plugin you wish to create like this:
![List of available plugin types to pick from](../assets/plugins/create-plugin_types.png)