From a243dcbcd839027a17228976714e3432c49b9081 Mon Sep 17 00:00:00 2001 From: Oliver Sand Date: Wed, 27 Jan 2021 09:39:40 +0100 Subject: [PATCH] Update readme --- .changeset/wet-suits-live.md | 1 + plugins/catalog-react/README.md | 17 +++++++---------- plugins/catalog/package.json | 2 +- 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/.changeset/wet-suits-live.md b/.changeset/wet-suits-live.md index 64fcd58d97..27b8df8a84 100644 --- a/.changeset/wet-suits-live.md +++ b/.changeset/wet-suits-live.md @@ -14,6 +14,7 @@ '@backstage/plugin-search': patch '@backstage/plugin-sentry': patch '@backstage/plugin-techdocs': patch +'@backstage/dev-utils': patch --- Switch dependency from `@backstage/plugin-catalog` to `@backstage/plugin-catalog-react`. diff --git a/plugins/catalog-react/README.md b/plugins/catalog-react/README.md index 574e23cf62..65ab45b9b2 100644 --- a/plugins/catalog-react/README.md +++ b/plugins/catalog-react/README.md @@ -1,17 +1,14 @@ -# Catalog Client +# Catalog React -Contains a frontend and backend compatible client for communicating with the -Backstage Catalog. +WORK IN PROGRESS -Backend code may import and use this package directly. +This is shared code of the frontend part of the default catalog plugin. -However, frontend code will not want to import this package directly - use the -`@backstage/plugin-catalog` package instead, which re-exports all of the types -and classes from this package. Thereby, you will also gain access to its -`catalogApiRef`. +It will implement the core API for handling your catalog of software, and +supplies components that can be reused by third-party plugins. ## Links -- [Default frontend part of the catalog](https://github.com/spotify/backstage/tree/master/plugins/catalog) -- [Default backend part of the catalog](https://github.com/spotify/backstage/tree/master/plugins/catalog-backend) +- [Frontend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/catalog) +- [Backend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend) - [The Backstage homepage](https://backstage.io) diff --git a/plugins/catalog/package.json b/plugins/catalog/package.json index 6752bcdfe6..bf30e28571 100644 --- a/plugins/catalog/package.json +++ b/plugins/catalog/package.json @@ -69,4 +69,4 @@ "files": [ "dist" ] -} \ No newline at end of file +}