Added initial scaffold for techdocs backend (#1550)

* Added initial scaffold for techdocs backend * Added test and a dummy route * Missed file in commit * Removed unused dependencies * Added readme
2020-07-07 15:37:26 +02:00
parent 10d1e141b7
commit be7ef69328
10 changed files with 226 additions and 1 deletions
@@ -0,0 +1,22 @@
+# techdocs-backend
+
+This is the backend part of the techdocs plugin.
+
+## Getting Started
+
+This backend 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 backend plugin itself.
+
+To evaluate the catalog and have a greater amount of functionality available, instead do
+
+```bash
+# in one terminal window, run this from from the very root of the Backstage project
+cd packages/backend
+yarn start
+```
+
+## Links
+
+- (Frontend part of the plugin)[https://github.com/spotify/backstage/tree/master/plugins/techdocs]
+- (The Backstage homepage)[https://backstage.io]