From e4d5628cf4fded262ab1e94860ae98f54e46d0ca Mon Sep 17 00:00:00 2001 From: blam Date: Fri, 14 Aug 2020 14:50:01 +0200 Subject: [PATCH] docs(catalog/grqphql): updating docs --- plugins/catalog-graphql/README.md | 14 ++++++-------- plugins/graphql/README.md | 6 +++--- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/plugins/catalog-graphql/README.md b/plugins/catalog-graphql/README.md index 3f85ec766e..cec3204c52 100644 --- a/plugins/catalog-graphql/README.md +++ b/plugins/catalog-graphql/README.md @@ -1,13 +1,11 @@ -# graphql +# Catalog GraphQL Plugin -Welcome to the graphql backend plugin! +## Getting Started -_This plugin was created through the Backstage CLI_ +This is the Catalog GraphQL plugin. -## Getting started +It provides the `catalog` part of the GraphQL schema. -Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/graphql](http://localhost:3000/graphql). +To register it with the GraphQL backend, be sure to follow the [Gettting Started](../graphql/README.md#getting-started) guide of the GraphQL plugin. -You can also serve the plugin in isolation by running `yarn start` in the plugin directory. -This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads. -It is only meant for local development, and the setup for it can be found inside the [/dev](/dev) directory. +