10 Commits

Author SHA1 Message Date
milliehartnt123 533bbe21fe Rewrite architectural overview for feature #21926 (#31209)
* Update architecture-overview.md

Updated the architectural overview. Rewrote sections and created new graphics.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Add files via upload

Architectural diagram of the Backstage frontend and backend.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Add files via upload

Added new graphics to illustrate simplified standalone plugin architecture, service-based-plugin-architecture, and third-party-plugin architecture.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Add files via upload

Cleaned up graphic

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Cleaned up service-based plugin graphic

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update architecture-overview.md

Updated graphics and added note to plugin architecture graphics.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Updated plugin-architecture heading links in architecture-overview.md

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update architecture-overview.md fix formatting

Fixed formatting that occurred during copy-paste. 

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update architecture-overview.md 

Rearranged some of the sections. Added additional text and links.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update architecture-overview.md fixed link for02-backends

Fixed link to backend-system/architecture/02-backends.md.  Forgot the "architecture" in the path.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update architecture-overview.md updated database section

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update architecture-overview.md added links for core frontend plugins

Added links and descriptions of the core frontend plugins. The links are back to the overview pages under features for each of the plugins

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Updated diagram to show Kubernetes as core plugin

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Updated graphics to remove the work Container

Changed "Frontend Container" to "Frontend". Changed "Backend Container" to "Backend"

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update architecture-overview.md

Changed "Frontend Container" to "Frontend" everywhere in the doc. Changed "Backend Container" to "Backend" everywhere in the doc.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update architecture-overview.md fixed backend spelling errors

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update architecture-overview.md try to fix prettier errors

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

* Update architecture-overview.md fix spelling error

Changed backed to backend

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>

---------

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
2025-10-01 16:23:33 -04:00
Patrik Oldsberg 6a8e728cf2 docs/architecture-overview: update to include new backend system
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2024-05-02 13:38:53 +02:00
Hao Luo a0d7fc3965 updated diagrams
Signed-off-by: Hao Luo <howlowck@gmail.com>
2022-10-13 17:20:32 -05:00
Hao Luo 85607e4998 updated diagrams
Signed-off-by: Hao Luo <howlowck@gmail.com>
2022-10-13 17:16:00 -05:00
Hao Luo 30926eed00 added diagrams
Signed-off-by: Hao Luo <howlowck@gmail.com>
2022-09-22 17:11:07 -05:00
Patrik Oldsberg f8b0197fc2 docs: add section to help decide where to place code
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-04-11 15:21:19 +02:00
Patrik Oldsberg 05f5bb5b53 docs: switch package architecture diagram to .drawio.svg
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-01-05 16:08:01 +01:00
Patrik Oldsberg 1834a02e16 docs: fix package architecture diagram reference
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-01-03 18:00:14 +01:00
imgbot[bot] 2d73c037a0 [ImgBot] Optimize images (#2747)
* [ImgBot] Optimize images

*Total -- 55,890.77kb -> 43,509.03kb (22.15%)

/microsite/static/img/techdocs.gif -- 49.31kb -> 10.58kb (78.55%)
/microsite/static/img/code.gif -- 157.03kb -> 35.17kb (77.61%)
/microsite/blog/assets/announcing-techdocs/discover1.png -- 55.93kb -> 23.34kb (58.27%)
/docs/assets/software-catalog/software-model-core-entities.png -- 16.87kb -> 7.07kb (58.12%)
/microsite/static/logo_assets/png/Backstage_Identity_Assets_Artwork_RGB_04_Icon_Teal.png -- 32.53kb -> 14.57kb (55.22%)
/microsite/static/logo_assets/png/Backstage_Identity_Assets_Artwork_RGB_03_Logo_Teal.png -- 105.45kb -> 51.51kb (51.15%)
/docs/assets/dls/designheader.png -- 121.73kb -> 60.13kb (50.6%)
/microsite/blog/assets/3/create-audit.png -- 364.83kb -> 183.61kb (49.67%)
/docs/assets/contributorheader.png -- 120.14kb -> 60.66kb (49.51%)
/docs/assets/dls/DLS.png -- 86.51kb -> 43.82kb (49.34%)
/microsite/blog/assets/3/lead.png -- 314.71kb -> 159.50kb (49.32%)
/microsite/blog/assets/3/audit-list.png -- 563.80kb -> 297.03kb (47.32%)
/microsite/static/img/logo-black-248x250.png -- 30.01kb -> 16.17kb (46.1%)
/microsite/blog/assets/3/audit-view.png -- 608.56kb -> 328.28kb (46.06%)
/docs/assets/architecture-overview/tech-radar-plugin-architecture.png -- 14.90kb -> 8.08kb (45.79%)
/microsite/blog/assets/3/lead-copy.png -- 503.29kb -> 277.35kb (44.89%)
/docs/assets/software-templates/running.png -- 1,049.75kb -> 586.42kb (44.14%)
/docs/assets/software-templates/complete.png -- 1,069.75kb -> 599.35kb (43.97%)
/microsite/static/logo_assets/png/Backstage_Identity_Assets_Artwork_RGB_06_Icon_Black.png -- 32.92kb -> 18.46kb (43.93%)
/plugins/api-docs/docs/openapi_definition.png -- 291.49kb -> 163.75kb (43.82%)
/plugins/api-docs/docs/api_list.png -- 269.36kb -> 151.45kb (43.78%)
/docs/assets/software-templates/template-picked.png -- 1,072.72kb -> 606.80kb (43.43%)
/docs/assets/software-templates/template-picked-2.png -- 1,071.40kb -> 606.57kb (43.38%)
/docs/assets/software-templates/failed.png -- 1,153.81kb -> 665.30kb (42.34%)
/microsite/blog/assets/20-07-01/auth-landing.png -- 158.46kb -> 91.53kb (42.24%)
/docs/assets/software-templates/added-to-the-catalog-list.png -- 1,124.62kb -> 652.22kb (42.01%)
/microsite/blog/assets/announcing-techdocs/metrics.png -- 262.48kb -> 152.43kb (41.93%)
/microsite/static/logo_assets/png/Backstage_Identity_Assets_Artwork_RGB_02_Icon_White.png -- 31.81kb -> 18.49kb (41.86%)
/docs/assets/techdocs/documentation-template.png -- 746.35kb -> 436.24kb (41.55%)
/docs/assets/software-templates/create.png -- 1,337.38kb -> 785.73kb (41.25%)
/docs/assets/architecture-decisions/catalog-core-entities.png -- 14.55kb -> 8.75kb (39.81%)
/plugins/newrelic/src/assets/img/newrelic-plugin-apm.png -- 695.89kb -> 420.09kb (39.63%)
/microsite/static/logo_assets/png/Backstage_Identity_Assets_Artwork_RGB_05_Logo_Black.png -- 103.79kb -> 62.99kb (39.31%)
/docs/assets/architecture-overview/core-vs-plugin-components-highlighted.png -- 264.85kb -> 161.79kb (38.91%)
/plugins/api-docs/docs/entity_tab_api.png -- 416.84kb -> 257.20kb (38.3%)
/microsite/blog/assets/Backstage-mural-DS.png -- 2,160.63kb -> 1,345.32kb (37.73%)
/plugins/newrelic/src/assets/img/newrelic-plugin-tools.png -- 1,065.29kb -> 664.61kb (37.61%)
/docs/assets/getting-started/create-app_output.png -- 101.97kb -> 64.10kb (37.13%)
/docs/assets/software-templates/go-to-catalog.png -- 1,230.83kb -> 775.46kb (37%)
/docs/assets/architecture-overview/lighthouse-plugin-architecture.png -- 23.35kb -> 14.72kb (36.98%)
/plugins/circleci/src/assets/screenshot-2.png -- 212.20kb -> 135.00kb (36.38%)
/docs/assets/architecture-overview/circle-ci.png -- 181.07kb -> 116.97kb (35.4%)
/docs/assets/architecture-overview/lighthouse-plugin.png -- 203.66kb -> 132.90kb (34.74%)
/plugins/tech-radar/docs/screenshot.png -- 1,036.52kb -> 679.66kb (34.43%)
/microsite/blog/assets/5/lead.png -- 1,036.52kb -> 679.66kb (34.43%)
/microsite/static/logo_assets/png/Backstage_Identity_Assets_Artwork_RGB_01_Logo_White.png -- 93.70kb -> 61.71kb (34.14%)
/plugins/circleci/src/assets/screenshot-1.png -- 234.92kb -> 155.14kb (33.96%)
/microsite/blog/assets/announcing-techdocs/docs-in-backstage.png -- 317.06kb -> 211.04kb (33.44%)
/docs/assets/architecture-overview/tech-radar-plugin.png -- 292.79kb -> 200.97kb (31.36%)
/microsite/static/animations/backstage-techdocs-icon-1.gif -- 198.18kb -> 137.41kb (30.66%)
/microsite/blog/assets/announcing-techdocs/github-issues.png -- 38.89kb -> 27.14kb (30.21%)
/packages/create-app/templates/default-app/packages/app/public/apple-touch-icon.png -- 17.62kb -> 12.32kb (30.07%)
/microsite/static/img/apple-touch-icon.png -- 17.62kb -> 12.32kb (30.07%)
/packages/app/public/apple-touch-icon.png -- 17.62kb -> 12.32kb (30.07%)
/microsite/blog/assets/20-05-20/tabs.png -- 148.84kb -> 104.22kb (29.97%)
/docs/assets/pop.png -- 101.26kb -> 71.10kb (29.78%)
/microsite/static/img/android-chrome-512x512.png -- 56.02kb -> 39.38kb (29.71%)
/packages/app/public/android-chrome-512x512.png -- 56.02kb -> 39.38kb (29.71%)
/microsite/static/img/android-chrome-192x192.png -- 18.76kb -> 13.28kb (29.21%)
/packages/app/public/android-chrome-192x192.png -- 18.76kb -> 13.28kb (29.21%)
/packages/create-app/templates/default-app/packages/app/public/android-chrome-192x192.png -- 18.76kb -> 13.28kb (29.21%)
/backstage_overview.png -- 349.28kb -> 248.87kb (28.75%)
/docs/assets/software-catalog/bsc-register-1.png -- 413.54kb -> 298.40kb (27.84%)
/docs/assets/headline.png -- 691.30kb -> 504.33kb (27.05%)
/docs/assets/software-catalog/bsc-register-2.png -- 234.00kb -> 171.24kb (26.82%)
/docs/assets/getting-started/create-plugin_output.png -- 269.42kb -> 198.20kb (26.44%)
/microsite/static/img/docs-like-code.png -- 339.46kb -> 251.42kb (25.94%)
/docs/assets/dls/running-storybook.png -- 57.86kb -> 42.87kb (25.92%)
/microsite/static/animations/backstage-standards-paradox-4.gif -- 306.22kb -> 228.17kb (25.49%)
/microsite/blog/assets/announcing-techdocs/feedback-loop2.png -- 67.58kb -> 50.86kb (24.73%)
/docs/assets/my-plugin_screenshot.png -- 389.08kb -> 292.91kb (24.72%)
/plugins/jenkins/src/assets/folder-results.png -- 79.84kb -> 60.46kb (24.28%)
/microsite/static/logo_assets/png/Backstage_Identity_Assets_Artwork_RGB_07_Large_Icon_Gradient.png -- 196.76kb -> 150.53kb (23.5%)
/plugins/jenkins/src/assets/build-details.png -- 31.98kb -> 24.56kb (23.2%)
/microsite/blog/assets/20-05-20/Service_Catalog_MVP_service.png -- 309.43kb -> 237.96kb (23.09%)
/microsite/static/img/mstile-150x150.png -- 13.23kb -> 10.20kb (22.91%)
/microsite/static/animations/backstage-software-templates-icon-5.gif -- 405.57kb -> 315.13kb (22.3%)
/microsite/blog/assets/4/welcome.png -- 376.54kb -> 292.86kb (22.22%)
/microsite/static/img/code.png -- 69.16kb -> 54.40kb (21.35%)
/docs/assets/software-catalog/service-catalog-home.png -- 384.40kb -> 302.66kb (21.26%)
/docs/assets/software-catalog/bsc-starred.png -- 53.59kb -> 42.96kb (19.84%)
/docs/assets/software-catalog/bsc-search.png -- 44.84kb -> 36.05kb (19.61%)
/microsite/static/animations/backstage-plugin-icon-2.gif -- 347.50kb -> 280.40kb (19.31%)
/microsite/blog/assets/4/create-app.png -- 302.95kb -> 244.52kb (19.29%)
/microsite/blog/assets/backstage-DS-header.png -- 1,338.46kb -> 1,082.15kb (19.15%)
/microsite/blog/assets/marketplace.png -- 367.66kb -> 298.65kb (18.77%)
/docs/assets/software-catalog/bsc-edit.png -- 45.43kb -> 37.16kb (18.21%)
/microsite/blog/assets/blog_1.png -- 561.80kb -> 463.54kb (17.49%)
/microsite/blog/assets/announcing-techdocs/discover2.png -- 64.44kb -> 53.17kb (17.49%)
/docs/assets/techdocs/techdocs_big_picture.png -- 133.86kb -> 111.10kb (17.01%)
/microsite/static/img/techdocs.png -- 208.08kb -> 173.11kb (16.8%)
/microsite/static/img/spring-boot-service.png -- 171.24kb -> 143.36kb (16.28%)
/microsite/static/img/techdocs-web.png -- 320.22kb -> 269.85kb (15.73%)
/microsite/blog/assets/backstage-world-DS.png -- 1,528.73kb -> 1,295.21kb (15.28%)
/docs/assets/auth/oauth-popup-flow.svg -- 20.01kb -> 17.00kb (15.06%)
/microsite/static/img/components-with-filter.png -- 364.44kb -> 309.95kb (14.95%)
/microsite/static/img/components-with-filter-small.png -- 150.06kb -> 128.05kb (14.66%)
/microsite/blog/assets/20-05-20/Service_Catalog_MVP.png -- 246.27kb -> 211.08kb (14.29%)
/microsite/blog/assets/backstage-guidelines-ds.png -- 85.14kb -> 73.96kb (13.13%)
/docs/assets/dls/designheader-updated.png -- 151.71kb -> 131.91kb (13.05%)
/microsite/static/animations/backstage-speed-paradox-7.gif -- 376.82kb -> 327.86kb (12.99%)
/microsite/blog/assets/2020-08-05/cards.png -- 208.43kb -> 184.39kb (11.54%)
/microsite/static/img/techdocs-static-mobile.png -- 160.35kb -> 143.15kb (10.73%)
/microsite/static/img/cards.png -- 669.88kb -> 600.47kb (10.36%)
/microsite/blog/assets/6/header.png -- 533.91kb -> 481.21kb (9.87%)
/microsite/blog/assets/backstage-figma1-DS.png -- 166.64kb -> 150.87kb (9.46%)
/microsite/static/img/cards-wide.png -- 195.96kb -> 180.35kb (7.97%)
/packages/create-app/templates/default-app/packages/app/public/safari-pinned-tab.svg -- 1.49kb -> 1.37kb (7.87%)
/packages/app/public/safari-pinned-tab.svg -- 1.49kb -> 1.37kb (7.87%)
/microsite/static/img/techs.png -- 428.84kb -> 395.16kb (7.85%)
/microsite/blog/assets/backstage-guide-DS.png -- 963.00kb -> 888.59kb (7.73%)
/microsite/static/img/cards-mobile.png -- 191.99kb -> 177.74kb (7.42%)
/plugins/newrelic/src/assets/img/newrelic.jpg -- 60.71kb -> 56.22kb (7.39%)
/microsite/blog/assets/announcing-techdocs/feedback-loop1.png -- 28.45kb -> 26.39kb (7.23%)
/microsite/static/animations/backstage-service-catalog-icon-1.gif -- 508.81kb -> 474.00kb (6.84%)
/docs/assets/utility-apis-fig1.svg -- 11.35kb -> 10.62kb (6.39%)
/packages/core/src/layout/ErrorPage/mic-drop.svg -- 7.52kb -> 7.07kb (6.05%)
/microsite/static/logo_assets/jpeg/Backstage_Identity_Assets_Artwork_RGB_05 Logo_Black.jpg -- 298.65kb -> 280.80kb (5.98%)
/docs/assets/dls/storybook-page.png -- 49.82kb -> 46.88kb (5.9%)
/plugins/jenkins/src/assets/last-master-build.png -- 19.63kb -> 18.49kb (5.8%)
/microsite/blog/assets/2020-08-05/catalog.png -- 380.78kb -> 360.72kb (5.27%)
/microsite/blog/assets/cncf-sandbox/cncf.png -- 809.62kb -> 770.66kb (4.81%)
/microsite/static/img/techdocs2.gif -- 87.60kb -> 83.40kb (4.8%)
/plugins/catalog/src/components/EntityNotFound/illo.svg -- 2.76kb -> 2.63kb (4.71%)
/microsite/blog/assets/2020-08-05/templates.png -- 476.55kb -> 454.66kb (4.59%)
/packages/core/src/components/EmptyState/assets/Background.svg -- 1.18kb -> 1.13kb (4.4%)
/microsite/static/img/favicon.svg -- 3.07kb -> 2.93kb (4.36%)
/packages/app/public/favicon.svg -- 3.09kb -> 2.96kb (4.32%)
/microsite/blog/assets/backstage-github-ds.png -- 336.42kb -> 321.91kb (4.31%)
/packages/core/src/components/EmptyState/assets/noInformation.svg -- 2.68kb -> 2.57kb (4.08%)
/microsite/static/logo_assets/jpeg/Backstage_Identity_Assets_Artwork_RGB_06_Icon_Black.jpg -- 113.58kb -> 109.47kb (3.62%)
/plugins/graphiql/src/assets/graphiql.icon.svg -- 2.65kb -> 2.56kb (3.61%)
/microsite/blog/assets/2020-08-05/template-form.png -- 230.18kb -> 222.74kb (3.23%)
/microsite/blog/assets/2020-08-05/create-component.png -- 223.74kb -> 217.37kb (2.85%)
/packages/core/src/components/EmptyState/assets/missingAnnotation.svg -- 2.31kb -> 2.25kb (2.62%)
/microsite/static/img/open-platform.svg -- 4.23kb -> 4.12kb (2.52%)
/microsite/static/img/compliance.svg -- 4.83kb -> 4.71kb (2.35%)
/microsite/static/img/logos-background.svg -- 1.10kb -> 1.08kb (2.22%)
/microsite/blog/assets/20-07-01/auth-sidebar.png -- 11.76kb -> 11.50kb (2.19%)
/microsite/static/img/laptop.svg -- 3.04kb -> 2.99kb (1.83%)
/microsite/blog/assets/backstage-storybook-ds.png -- 313.36kb -> 309.68kb (1.18%)
/microsite/static/img/dot.svg -- 541.46kb -> 535.46kb (1.11%)
/packages/core/src/components/EmptyState/assets/createComponent.svg -- 4.59kb -> 4.54kb (1.06%)
/microsite/static/img/plugin-mobile.svg -- 27.07kb -> 26.79kb (1.02%)
/packages/core/src/components/EmptyState/assets/noBuild.svg -- 6.41kb -> 6.35kb (0.93%)
/microsite/blog/assets/illustration.svg -- 26.76kb -> 26.55kb (0.79%)
/microsite/static/img/plugin.svg -- 29.91kb -> 29.69kb (0.72%)
/microsite/static/img/demo-illustration.svg -- 18.04kb -> 17.95kb (0.48%)
/microsite/static/animations/backstage-logos-hero-8.gif -- 1,421.52kb -> 1,415.28kb (0.44%)
/microsite/static/img/developers.svg -- 16.95kb -> 16.88kb (0.41%)
/microsite/static/img/logo-gradient-on-dark.svg -- 4.86kb -> 4.84kb (0.4%)
/microsite/static/img/screen.gif -- 1,181.89kb -> 1,178.40kb (0.3%)
/microsite/blog/assets/backstage-discord-DS.png -- 667.78kb -> 665.89kb (0.28%)
/microsite/static/logo_assets/svg/Icon_Gradient.svg -- 3.38kb -> 3.38kb (0.12%)
/microsite/static/img/logos-signature.svg -- 12.67kb -> 12.67kb (0.05%)
/microsite/static/img/embraced.svg -- 230.47kb -> 230.38kb (0.04%)
/microsite/static/logo_assets/svg/Icon_White.svg -- 2.91kb -> 2.91kb (0.03%)
/microsite/static/logo_assets/svg/Icon_Teal.svg -- 2.91kb -> 2.91kb (0.03%)
/microsite/static/logo_assets/svg/Icon_Black.svg -- 2.91kb -> 2.91kb (0.03%)
/microsite/static/img/cncf-color.svg -- 4.74kb -> 4.74kb (0.02%)
/microsite/static/img/logos.svg -- 1,304.26kb -> 1,304.00kb (0.02%)
/microsite/static/img/cncf-white.svg -- 6.32kb -> 6.32kb (0.02%)
/microsite/static/img/laptop-screen.svg -- 148.40kb -> 148.39kb (0.01%)
/microsite/static/logo_assets/svg/Logo_White.svg -- 12.58kb -> 12.58kb (0.01%)
/microsite/static/img/logo.svg -- 12.58kb -> 12.58kb (0.01%)
/microsite/static/logo_assets/svg/Logo_Teal.svg -- 12.58kb -> 12.58kb (0.01%)
/microsite/static/img/backstage-logo-cncf.svg -- 12.58kb -> 12.58kb (0.01%)
/microsite/static/logo_assets/svg/Logo_Black.svg -- 12.58kb -> 12.58kb (0.01%)
/microsite/blog/assets/2/screen.gif -- 1,178.42kb -> 1,178.40kb (0%)
/microsite/static/img/photo-montage.svg -- 6,381.23kb -> 6,381.18kb (0%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>

* Revert documentation SVG changes.

* Do not compress SVG files in documentation.

They are likely created/maintained by hand.

Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
Co-authored-by: Eric Peterson <ericpeterson@spotify.com>
2020-10-05 14:39:56 +02:00
Ivan Shmidt 882728ae1d feat: the whole docs structure
Co-authored-by: Raghunandan Balachandran <meetraghu28@gmail.com>
Co-authored-by: Ben Lambert <ben@blam.sh>
2020-08-12 15:20:20 +02:00