Files

T

Eric Peterson f3599989c7 Add catalog-info.yaml files for TechDocs project area

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

2023-08-21 13:21:11 +02:00

dev

Review feedback 2: electric boogaloo

2022-04-12 15:37:29 +02:00

src

techdocs: mock facets endpoint

2023-06-12 13:37:29 +02:00

.eslintrc.js

packages,plugins: migrate to new lint config

2022-03-07 14:53:43 +01:00

api-report.md

api-reports

2023-08-18 14:00:29 +02:00

catalog-info.yaml

Add catalog-info.yaml files for TechDocs project area

2023-08-21 13:21:11 +02:00

CHANGELOG.md

Version Packages

2023-08-15 17:12:48 +00:00

config.d.ts

clean up deprecations of techdocs plugin

2022-03-14 22:39:17 +01:00

package.json

Version Packages

2023-08-15 17:12:48 +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.