From 72ce0f8b163b4d01a309064cad99f6f5af20e36e Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Thu, 14 Jan 2021 02:04:57 +0100 Subject: [PATCH] docs/composability: include in sidebar and add note about purpose --- docs/plugins/composability.md | 11 ++++++----- microsite/sidebars.json | 1 + 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/plugins/composability.md b/docs/plugins/composability.md index 3e38f3376e..e6f00d2374 100644 --- a/docs/plugins/composability.md +++ b/docs/plugins/composability.md @@ -1,6 +1,6 @@ --- id: composability -title: New Composability System +title: Composability System Migration description: Documentation and migration instructions for new composability APIs. --- @@ -8,10 +8,11 @@ description: ## Summary This page describes the new composability system that was recently introduced in -Backstage. It describes the new system from the perspective of the existing -patterns and APIs. As the new system is solidified and existing code is ported, -this page will removed and replaced with a more direct description of the -composability system. +Backstage, and it does so from the perspective of the existing patterns and +APIs. As the new system is solidified and existing code is ported, this page +will removed and replaced with a more direct description of the composability +system. For now, the primary purpose of this documentation is to aid in the +migration of existing plugins, but it does cover the migration of apps as well. The core principle of the new composability system is that plugins should have clear boundaries and connections. It should isolate crashes within a plugin, but diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 3d6417cc65..05e421cb19 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -95,6 +95,7 @@ "plugins/plugin-development", "plugins/structure-of-a-plugin", "plugins/integrating-plugin-into-service-catalog", + "plugins/composability", { "type": "subcategory", "label": "Backends and APIs",