Files
backstage/plugins/techdocs
Patrik Oldsberg 602b5b59bb packages: regenerate all API reports with prettier
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-07-12 19:54:11 +02:00
..
2021-06-22 10:07:18 +02:00
2021-07-08 11:37:02 +00:00
2021-06-18 20:26:42 +02:00
2021-07-08 11:37:02 +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).