Files

T

Patrik Oldsberg d0d78ebc7c Merge pull request #7181 from backstage/rugvip/descriptions

Add package descriptions + separate table for plugins in API reference

2021-09-15 17:25:27 +02:00

dev

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

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

src

Merge pull request #7181 from backstage/rugvip/descriptions

2021-09-15 17:25:27 +02:00

.eslintrc.js

feat(techdocs): yarn create-plugin

2020-06-22 13:42:42 +02:00

api-report.md

packages,plugins: add package documentation

2021-09-14 18:47:53 +02:00

CHANGELOG.md

Version Packages

2021-09-02 10:41:57 +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

plugins: add package descriptions

2021-09-14 18:33:40 +02: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).