From 3556551f3d3230911c2e2051995312e6622617a5 Mon Sep 17 00:00:00 2001 From: Mohit Nain Date: Tue, 6 May 2025 20:04:43 +0530 Subject: [PATCH 1/2] Update architecture-overview.md Signed-off-by: Mohit Nain --- docs/overview/architecture-overview.md | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/docs/overview/architecture-overview.md b/docs/overview/architecture-overview.md index d1be2bb2fc..a3c15aa480 100644 --- a/docs/overview/architecture-overview.md +++ b/docs/overview/architecture-overview.md @@ -6,20 +6,11 @@ description: Documentation on Architecture overview ## Terminology -Backstage is constructed out of three parts. We separate Backstage in this way -because we see three groups of contributors that work with Backstage in three -different ways. +Backstage is organized into three main components, each catering to different groups of contributors who interact with Backstage in distinct ways. -- Core - Base functionality built by core developers in the open source project. -- App - The app is an instance of a Backstage app that is deployed and tweaked. - The app ties together core functionality with additional plugins. The app is - built and maintained by app developers, usually a productivity team within a - company. -- Plugins - Additional functionality to make your Backstage app useful for your - company. Plugins can be specific to a company or open sourced and reusable. At - Spotify we have over 100 plugins built by over 50 different teams. It has been - very powerful to get contributions from various infrastructure teams added - into a single unified developer experience. +- Core - This includes the base functionality developed by core developers within the open-source project. +- App - The app represents a deployed instance of a Backstage application, customized and maintained by app developers, typically a productivity team within an organization. It integrates core functionalities with additional plugins. +- Plugins - These provide additional functionalities to enhance the usefulness of your Backstage app. Plugins can be company-specific or open-sourced and reusable. At Spotify, we have over 100 plugins created by more than 50 different teams, significantly enriching the unified developer experience by incorporating contributions from various infrastructure teams. ## Overview From 9754e48e6603fcea4438ad8e9eb763831f46b9c2 Mon Sep 17 00:00:00 2001 From: Mohit Nain Date: Wed, 7 May 2025 11:49:59 +0530 Subject: [PATCH 2/2] Update architecture-overview.md Signed-off-by: Mohit Nain --- docs/overview/architecture-overview.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/overview/architecture-overview.md b/docs/overview/architecture-overview.md index a3c15aa480..035be95769 100644 --- a/docs/overview/architecture-overview.md +++ b/docs/overview/architecture-overview.md @@ -267,14 +267,14 @@ require a database to work with. The Backstage backend and its built-in plugins are based on the [Knex](http://knexjs.org/) library, and set up a separate logical database per plugin. This gives great isolation and lets them perform migrations and evolve -separate from each other. +separately from each other. -The Knex library supports a multitude of databases, but Backstage is at the time -of writing tested primarily against two of them: SQLite, which is mainly used as +The Knex library supports a multitude of databases, but Backstage at this time +of writing is tested primarily against two of them: SQLite, which is mainly used as an in-memory mock/test database, and PostgreSQL, which is the preferred production database. Other databases such as the MySQL variants are reported to work but -[aren't tested as fully](https://github.com/backstage/backstage/issues/2460) +[aren't fully tested](https://github.com/backstage/backstage/issues/2460) yet. ## Cache