Files

T

Anastasia Rodionova 2e1fbe203b Do not add / for html pages in rewriteDocLinks

Signed-off-by: Anastasia Rodionova <argali96@gmail.com>

2021-06-09 10:28:47 +02:00

dev

Use interface and not implementation in ApiRef<T>

2021-04-23 12:48:13 +02:00

src

Do not add / for html pages in rewriteDocLinks

2021-06-09 10:28:47 +02:00

.eslintrc.js

feat(techdocs): yarn create-plugin

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

CHANGELOG.md

Version Packages

2021-06-03 13:23:54 +02:00

config.d.ts

TechDocs: Separate backend and frontend config schema declarations

2021-03-16 15:48:46 +01:00

package.json

Version Packages

2021-06-03 13:23:54 +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).