From 3dc64e931e96085489b8b7060908d4280287a0ed Mon Sep 17 00:00:00 2001 From: Camila Belo Date: Thu, 1 Feb 2024 19:28:12 +0100 Subject: [PATCH] docs: add changeset files Signed-off-by: Camila Belo --- .changeset/mighty-toys-laugh.md | 5 + .changeset/neat-eels-greet.md | 5 + packages/app-next/app-config.yaml | 4 +- plugins/catalog-graph/EXPERIMENTAL.md | 286 ++++++++++++------ .../catalog-graph-entity-relations-card.png | Bin 0 -> 236847 bytes .../catalog-graph-entity-relations-page.png | Bin 0 -> 158626 bytes 6 files changed, 204 insertions(+), 96 deletions(-) create mode 100644 .changeset/mighty-toys-laugh.md create mode 100644 .changeset/neat-eels-greet.md create mode 100644 plugins/catalog-graph/catalog-graph-entity-relations-card.png create mode 100644 plugins/catalog-graph/catalog-graph-entity-relations-page.png diff --git a/.changeset/mighty-toys-laugh.md b/.changeset/mighty-toys-laugh.md new file mode 100644 index 0000000000..ad48e84565 --- /dev/null +++ b/.changeset/mighty-toys-laugh.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-react': minor +--- + +Add support to `configSchema` option on the `createEntityCardExtension` factory function. diff --git a/.changeset/neat-eels-greet.md b/.changeset/neat-eels-greet.md new file mode 100644 index 0000000000..5ba4777934 --- /dev/null +++ b/.changeset/neat-eels-greet.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-graph': minor +--- + +Migrate plugin to the new frontend system, it is experimental and available via alpha subpath. diff --git a/packages/app-next/app-config.yaml b/packages/app-next/app-config.yaml index 7402493179..f43fe32faa 100644 --- a/packages/app-next/app-config.yaml +++ b/packages/app-next/app-config.yaml @@ -16,7 +16,9 @@ app: config: filter: kind:component has:links - entity-card:linguist/languages - - entity-card:catalog-graph/entity-relations + - entity-card:catalog-graph/entity-relations: + config: + height: 300 # Entity page content - entity-content:techdocs diff --git a/plugins/catalog-graph/EXPERIMENTAL.md b/plugins/catalog-graph/EXPERIMENTAL.md index 5870b30e4b..9af7dbea66 100644 --- a/plugins/catalog-graph/EXPERIMENTAL.md +++ b/plugins/catalog-graph/EXPERIMENTAL.md @@ -1,224 +1,320 @@ -# catalog-graph +# Catalog Graph -> **Disclaimer:** +> [!WARNING] > This documentation is made for those using the experimental new Frontend system. > If you are not using the new Backstage frontend system, please go [here](./README.md). -Welcome to the catalog graph plugin! The catalog graph visualizes the relations -between entities, like ownership, grouping or API relationships. +The Catalog graph plugin helps you to visualize the relations between entities, like ownership, grouping or API relationships. +It comes with these features: -The plugin comes with these features: +- A card that displays the directly related entities to the current entity on the Catalog entity page. It can be customized, for example filtering for specific relations. -- Catalog entity relations graph card: - A card that displays the directly related entities to the current entity. - This card is for use on the entity page. - The card can be customized, for example filtering for specific relations. -