Files
backstage/plugins/techdocs
Patrik Oldsberg 560e0dd0b2 Merge pull request #5968 from ougfh/fix-doc-navigation-links-for-non-dir-urls
Do not add / for html pages in rewriteDocLinks
2021-06-15 18:23:40 +02:00
..
2021-06-03 13:23:54 +02:00
2021-06-10 12:18:06 +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).