Files

T

Bodil Björklund edda769360 Minor text edits

Piggy-backing on this branch to include minor text edits to README.

Signed-off-by: Bodil Björklund <bodilb@spotify.com>

2021-09-27 17:19:54 +02:00

dev

Show a "Refresh" button to if the content is stale

2021-07-05 15:07:08 +02:00

src

Add check for TechDocs annotation on entity

2021-09-25 10:11:42 -05:00

.eslintrc.js

…

api-report.md

Updated API Report

2021-09-26 10:59:23 -05:00

CHANGELOG.md

Version Packages

2021-09-23 10:01:17 +00:00

config.d.ts

Use lower-case links within techdocs plugin; allow legacy behavior with config.

2021-08-10 13:38:07 +02:00

package.json

Version Packages

2021-09-23 10:01:17 +00:00

README.md

Minor text edits

2021-09-27 17:19:54 +02:00

README.md

TechDocs Plugin

Getting started

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

Configuration

Refer to our configuration reference for a complete listing of configuration options.

TechDocs Storage API

The default setup of TechDocs assumes that your documentation is accessed by reading a page with the format of <storageUrl>/<entity kind>/<entity namespace>/<entity name>. This can be configured by implementing a new techdocs storage API.