Files
backstage/plugins/techdocs
Jonah Grimes fef852ecd3 Reworked TechDocs page subtitle to reflect the company/organization name (#5317)
* reworked page subtitle to reflect the company/organization name instead of 'Backstage'

Signed-off-by: Jonah Grimes <jgrimes@appriss.com>

* ran prettier to reformat code

Signed-off-by: Jonah Grimes <jgrimes@appriss.com>

* marked changeset as techdocs only

Signed-off-by: Jonah Grimes <jgrimes@appriss.com>
2021-04-14 16:45:20 +02:00
..
2021-03-31 12:21:12 +00:00
2021-04-08 11:32:56 +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).