Files
backstage/plugins/techdocs
github-actions[bot] 0e120c5c66 Version Packages
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-03-11 13:45:44 +01:00
..
2021-03-01 12:29:59 +01:00
2021-03-11 13:45:44 +01:00
2021-03-11 13:45:44 +01: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).