Files
backstage/plugins/techdocs
jrusso1020 65e6c45410 Remove circular dependencies
In reference to issue #5563 this does the initial work to remove
all the circular dependencies that we have encountered while
building backstage using bazel. The next step will be to implement
a method to catch these circular dependencies before they get
merged in

Signed-off-by: jrusso1020 <jrusso@brex.com>
2021-05-15 11:17:05 -06:00
..
2021-05-15 11:17:05 -06:00
2021-05-12 09:39:51 +00:00
2021-05-12 09:39:51 +00:00

TechDocs Plugin

Getting started

Set up Backstage and TechDocs by follow our guide on Getting Started.

Configuration

http://backstage.io/docs/features/techdocs/configuration

TechDocs Storage Api

The default setup of TechDocs assumes your documentation is accessed by reading a page with the format of <storageUrl>/<entity kind>/<entity namespace>/<entity name>. If for some reason you want to change this it can be configured by implementing a new techdocs storage API. Do this by implementing TechDocsStorage found in plugins/techdocs/src/api. Add your new API to the application in app/src/apis.ts (or replace if it's already registered as an API).