Files

T

Adam Harvey 59b1b04f0b Merge pull request #4314 from adamdmharvey/techdocs-error500

techdocs: Expose backend 500 errors (mkdocs build) to UI

2021-02-05 12:26:52 -05:00

dev

techdocs: migrate to new composability API

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

src

Merge pull request #4314 from adamdmharvey/techdocs-error500

2021-02-05 12:26:52 -05:00

.eslintrc.js

…

CHANGELOG.md

Version Packages

2021-02-04 13:02:30 +00:00

config.d.ts

TechDocs: Use @deprecated for techdocs config urls

2021-02-02 23:16:09 +01:00

package.json

Version Packages

2021-02-04 13:02:30 +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).