From d8e2b51fa3fa313e22e77340bc01b2d0d3b93dc5 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Fri, 20 Jan 2023 13:31:56 +0100 Subject: [PATCH] docs/backend-system: add architecture diagram Signed-off-by: Patrik Oldsberg --- .../architecture-building-blocks.drawio.svg | 112 ++++++++++++++++++ docs/backend-system/architecture/01-index.md | 8 +- 2 files changed, 118 insertions(+), 2 deletions(-) create mode 100644 docs/assets/backend-system/architecture-building-blocks.drawio.svg diff --git a/docs/assets/backend-system/architecture-building-blocks.drawio.svg b/docs/assets/backend-system/architecture-building-blocks.drawio.svg new file mode 100644 index 0000000000..0244d461c6 --- /dev/null +++ b/docs/assets/backend-system/architecture-building-blocks.drawio.svg @@ -0,0 +1,112 @@ + + + + + + + + + + + +
+
+
+ Backend +
+
+
+ + + Backend + + + + + + + +
+
+
+ Services +
+
+
+ + + Services + + + + + + + + + + + +
+
+
+ Plugins +
+
+
+ + + Plugins + + + + + + + +
+
+
+ Extension Points +
+
+
+ + + Extension Poi... + + + + + + + + + + + +
+
+
+ Modules +
+
+
+ + + Modules + + + + + + + + + + + Viewer does not support full SVG 1.1 + + + + diff --git a/docs/backend-system/architecture/01-index.md b/docs/backend-system/architecture/01-index.md index 5e6fb60ee6..e3354112fb 100644 --- a/docs/backend-system/architecture/01-index.md +++ b/docs/backend-system/architecture/01-index.md @@ -15,9 +15,13 @@ the new system. ## Building Blocks -This section introduces the high-level building blocks upon which this new system is built. These are all concepts that exist in our current system in one way or another, but they have all been lifted up to be first class concerns in the new system. +This section introduces the high-level building blocks upon which this new system is built. Regardless of whether you are setting up your own backstage instance, developing plugins, or extending plugins with new features, it is important to understand these concepts. - +The diagram below provides an overview of the different building blocks, and the other blocks that each of them interact with. + +![backend system building blocks diagram](../../assets/backend-system/architecture-building-blocks.drawio.svg) + +> NOTE: These are all concepts that existed in our old backend system in one way or another, but they have now all been lifted up to be first class concerns. ### Backend