Files

T

Vincenzo Scamporlino 8a18e9ef38 techdocs: make builder optional

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>

2024-05-07 14:29:57 +02:00

dev

…

src

techdocs: make builder optional

2024-05-07 14:29:57 +02:00

.eslintrc.js

feat: add eslint rule for top level imports

2024-03-14 14:41:53 +00:00

api-report-alpha.md

…

api-report.md

chore: update api report

2024-03-14 16:28:09 +00:00

catalog-info.yaml

…

CHANGELOG.md

Version Packages (next)

2024-04-30 11:22:01 +00:00

config.d.ts

techdocs: make builder optional

2024-05-07 14:29:57 +02:00

knip-report.md

…

package.json

Version Packages (next)

2024-04-30 11:22:01 +00:00

README.md

Updating Readme docs

2024-04-18 15:47:14 -04: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 namespace>/<entity kind>/<entity name>. This can be configured by implementing a new techdocs storage API.