Files

T

Fredrik Adelöw dedee41f57 Merge pull request #4572 from backstage/freben/attr

got rid of some attr and cleaned up a bit in techdocs schema

2021-02-19 10:10:04 +01:00

dev

techdocs: migrate to new composability API

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

src

Merge branch 'master' of github.com:backstage/backstage into improve-errors

2021-02-08 11:48:19 -05:00

.eslintrc.js

…

CHANGELOG.md

Version Packages

2021-02-18 13:23:19 +00:00

config.d.ts

got rid of some attr and cleaned up a bit in techdocs schema

2021-02-18 11:15:18 +01:00

package.json

Version Packages

2021-02-18 13:23:19 +00: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).