paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 19 Packages Projects Releases Wiki Activity

docs/backend-system: add plugin creation section

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-01-27 13:08:40 +01:00
parent 76b838a854
commit 27cceaead8
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/backend-system/building-plugins-and-modules/01-index.md
+6
View File
@@ -16,6 +16,12 @@ Backend [plugins](../architecture/04-plugins.md) and
backend _features_, are the building blocks that adopters add to their
[backends](../architecture/02-backends.md).
## Creating a new Plugin
This guide assumes that you already have a Backend project set up. Even if you only want to develop a single plugin for publishing, we still recommend that you do so in a standard Backstage monorepo project, as you often end up needing multiple package. For instructions on how to set up a new project, see our [getting started](../../getting-started/index.md#prerequisites) documentation.
To create a Backend plugin, run `yarn new`, select `backend-plugin`, and fill out the rest of the prompts. This will create a new package at `plugins/<pluginId>-backend`, which will be the main entrypoint for your plugin.
## Plugins
A basic backend plugin might look as follows: