Merge pull request #5383 from adamdmharvey/tweak-doco

docs(catalog): Remove WIP
2021-04-20 11:10:27 -04:00
parent 71cf82deee 772f60f14b
commit c9e43525a9
1 changed files with 16 additions and 3 deletions
@@ -1,12 +1,25 @@
-# Catalog Frontend
-
-WORK IN PROGRESS
+# Backstage Catalog Frontend

 This is the frontend part of the default catalog plugin.

 It will implement the core API for handling your catalog of software, and
 supply the base views to show and manage them.

+## Getting Started
+
+This frontend plugin can be started in a standalone mode from directly in this package
+with `yarn start`. However, it will have limited functionality and that process is
+most convenient when developing the catalog frontend plugin itself.
+
+To evaluate the catalog and have a greater amount of functionality available, from the main
+Backstage root folder, instead do:
+
+```bash
+yarn dev
+```
+
+This will launch both frontend and backend in the same window, populated with some example entities.
+
 ## Links

 - [Backend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/catalog-backend)