diff --git a/docs/backend-system/architecture/01-index.md b/docs/backend-system/architecture/01-index.md index 76953f7009..aff730b0d1 100644 --- a/docs/backend-system/architecture/01-index.md +++ b/docs/backend-system/architecture/01-index.md @@ -1,7 +1,7 @@ --- id: index title: Backend System Architecture -sidebar_label: System Architecture +sidebar_label: Overview # prettier-ignore description: The structure and architecture of the new Backend System and its component parts --- diff --git a/docs/backend-system/architecture/06-modules.md b/docs/backend-system/architecture/06-modules.md index 53aae9e38d..b4a2e8338a 100644 --- a/docs/backend-system/architecture/06-modules.md +++ b/docs/backend-system/architecture/06-modules.md @@ -43,7 +43,3 @@ export const catalogModuleExampleCustomProcessor = createBackendModule({ Notice that we're placing the extension point we want to interact with in the `deps` option, while also depending on the logger service at the same time. When initializing modules we can depend on both extension points and services interchangeably. You can also depend on multiple extension points at once, in case the implementation of the module requires it. It is typically best to keep modules slim and to each only add a single new feature. It is often the case that it is better to create two separate modules rather than one that provides both features. The one limitation here is that modules can not interact with each other and need to be self contained. - -## HTTP Handlers - -Since modules have access to the same services as the plugin they extend, they are also able to register their own HTTP handlers. For more information about the HTTP service, see [core services](../core-services/01-index.md). When registering HTTP handlers, it is important to try to avoid any future conflict with the plugin itself, or other modules. A recommended naming pattern is to register the handlers under the `/modules/` path, where `` is the kebab-case ID of the module, for example `/modules/example-custom-processor/v1/validators`. In a standard backend setup the full path would then be `/api/catalog/modules/example-custom-processor/v1/validators`. diff --git a/docs/backend-system/building-backends/01-index.md b/docs/backend-system/building-backends/01-index.md index 65c536afdd..66bf68ab07 100644 --- a/docs/backend-system/building-backends/01-index.md +++ b/docs/backend-system/building-backends/01-index.md @@ -11,12 +11,12 @@ description: Building backends using the new backend system > NOTE: If you have an existing backend that is not yet using the new backend > system, see [migrating](./08-migrating.md). +This section covers how to set up and customize your own Backstage backend. It covers some aspects of how backend instances fit into the larger system, but for a more in-depth explanation of the role of backends in the backend system, see [the architecture section](../architecture/02-backends.md). + # Overview A minimal Backstage backend is very lightweight. It is a single package with a `package.json` file and a `src/index.ts` file, not counting surrounding tooling and documentation. The package is typically placed within the `packages/backend` folder of a Backstage monorepo, but that is up to you. The backend package is part of any project created with `@backstage/create-app`, so you typically do not need to create it yourself. -You'll get a brief description here, but for a more in-depth explanation of the role of backends in the backend system, see [the architecture section](../architecture/02-backends.md). - When you create a new project with `@backstage/create-app`, you'll get a backend package with a `src/index.ts` that looks something like this: ```ts 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 848a38ce16..1556b6b377 100644 --- a/docs/backend-system/building-plugins-and-modules/01-index.md +++ b/docs/backend-system/building-plugins-and-modules/01-index.md @@ -11,11 +11,9 @@ description: Building backend plugins and modules using the new backend system > NOTE: If you have an existing backend and/or backend plugins that are not yet > using the new backend system, see [migrating](./08-migrating.md). -## Overview - -Backend [plugins](../architecture/04-plugins.md) and -[modules](../architecture/06-modules.md), sometimes collectively referred to as -backend _features_, are the building blocks that adopters add to their +This section covers how to build your own backend [plugins](../architecture/04-plugins.md) and +[modules](../architecture/06-modules.md). They are sometimes collectively referred to as +backend _features_, and are the building blocks that adopters add to their [backends](../architecture/02-backends.md). ## Creating a new Plugin diff --git a/docs/backend-system/core-services/01-index.md b/docs/backend-system/core-services/01-index.md index 6448943e3a..c688055c96 100644 --- a/docs/backend-system/core-services/01-index.md +++ b/docs/backend-system/core-services/01-index.md @@ -1,7 +1,7 @@ --- id: index title: Core Backend Service APIs -sidebar_label: Core Services +sidebar_label: Overview # prettier-ignore description: Core backend service APIs --- diff --git a/docs/backend-system/index.md b/docs/backend-system/index.md index d2d7c8e69e..87eb008129 100644 --- a/docs/backend-system/index.md +++ b/docs/backend-system/index.md @@ -1,7 +1,7 @@ --- id: index title: The Backend System -sidebar_label: Overview +sidebar_label: Introduction # prettier-ignore description: The Backend System ---