Merge pull request #6197 from backstage/rugvip/adrup
docs/adr011: add backend module naming pattern
This commit is contained in:
@@ -35,6 +35,8 @@ example `catalog` or `techdocs`):
|
||||
|
||||
- `x`: Contains the main frontend code of the plugin.
|
||||
- `x-backend`: Contains the main backend code of the plugin.
|
||||
- `x-backend-module-<name>`: Contains optional modules related to the backend
|
||||
plugin.
|
||||
- `x-react`: Contains shared widgets, hooks and similar that both the plugin
|
||||
itself (`x`) and third-party frontend plugins can depend on.
|
||||
- `x-node`: Contains utilities for backends that both the plugin backend itself
|
||||
@@ -61,6 +63,10 @@ We will actively migrate existing packages that are part of a plugin to the
|
||||
`plugins/catalog-common` we might want to do an exception here, as it's a very
|
||||
central package.
|
||||
|
||||
We will actively migrate optional features of backend plugins into separate
|
||||
`x-backend-module-<name>` packages, for example the more specialized processors
|
||||
in the catalog backend.
|
||||
|
||||
The limited set of rules might not be sufficient in the future. If additional
|
||||
packages are required, we will revisit this decision and extend the pattern.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user