paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
Files
7e7cec86acbf66b22bbfb432844ae19dae0ed2bc
backstage/plugins/techdocs/README.md
T
Himanshu Mishra 372160ede5 Update README of all three techdocs packages/plugins
2020-12-05 18:07:50 +01:00

725 B
Raw Blame History

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).

Reference in New Issue View Git Blame Copy Permalink