Files

T

Elliot Greenwood 04b2ecd23c Add link to owner from the techdocs header

Signed-off-by: Elliot Greenwood <hello@elliotgreenwood.co.uk>

2021-02-23 23:56:23 +00:00

dev

techdocs: migrate to new composability API

2021-02-04 20:22:50 +01:00

src

Add link to owner from the techdocs header

2021-02-23 23:56:23 +00:00

.eslintrc.js

…

CHANGELOG.md

Version Packages

2021-02-23 10:31:40 +01:00

config.d.ts

Merge pull request #4500 from backjo/feature/aws-assume-role

2021-02-22 08:32:52 +01:00

package.json

Version Packages

2021-02-23 10:31:40 +01:00

README.md

Update README of all three techdocs packages/plugins

2020-12-05 18:07:50 +01:00

README.md

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