Files

T

Emma Indal 969cf48858 [TechDocs] migrate techdocs to use new routing/catalog api (#2312 )

* migrate techdocs to use new routing

* use new techdocs routing in default app

* new EntityPageDocs and Router components

* remove unused code

* remove unused import

2020-09-07 16:56:03 +02:00

dev

2020-08-27 14:01:09 +02:00

src

[TechDocs] migrate techdocs to use new routing/catalog api (#2312 )

2020-09-07 16:56:03 +02:00

.eslintrc.js

…

package.json

new release 31 aug 20

2020-09-01 14:10:22 +02:00

README.md

Updated docs for techdocs plugin (#2127 )

2020-08-27 09:52:49 +02:00

README.md

TechDocs Plugin

Getting started

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

Configuration

Custom Storage URL

TechDocs will try to read your documentation from the URL you have specified in the techdocs storageUrl in app-config.yml.

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