From 27cceaead8bdf0d06b7d61901fa83668f762e55d Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Fri, 27 Jan 2023 13:08:40 +0100 Subject: [PATCH] docs/backend-system: add plugin creation section Signed-off-by: Patrik Oldsberg --- .../backend-system/building-plugins-and-modules/01-index.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/backend-system/building-plugins-and-modules/01-index.md b/docs/backend-system/building-plugins-and-modules/01-index.md index 05908e59cb..7603306b33 100644 --- a/docs/backend-system/building-plugins-and-modules/01-index.md +++ b/docs/backend-system/building-plugins-and-modules/01-index.md @@ -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/-backend`, which will be the main entrypoint for your plugin. + ## Plugins A basic backend plugin might look as follows: