Files

T

Camila Belo db58cf06c2 fix(techdocs-plugin): apply review suggestions

- strict regex scope to avoid security issues
- add techdocs prefix to the changeset file

Signed-off-by: Camila Belo <camilaibs@gmail.com>

2021-08-03 08:56:01 +02:00

dev

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

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

src

fix(techdocs-plugin): apply review suggestions

2021-08-03 08:56:01 +02:00

.eslintrc.js

…

api-report.md

Merge pull request #6375 from RoadieHQ/gh4568-tech-docs-collator

2021-07-21 15:01:48 +02:00

CHANGELOG.md

Version Packages

2021-07-29 10:32:54 +00:00

config.d.ts

Update copyright headers

2021-06-18 20:26:42 +02:00

package.json

Version Packages

2021-07-29 10:32:54 +00:00

README.md

…

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).