Files

T

Dominik Henneke 4255617c2e Show the error alert on the not found page in case there are sync errors

This allows access to the build logs in the initial build view

Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>

2021-07-09 14:33:54 +02:00

dev

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

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

src

Show the error alert on the not found page in case there are sync errors

2021-07-09 14:33:54 +02:00

.eslintrc.js

feat(techdocs): yarn create-plugin

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

api-report.md

Rewrite the /sync/:namespace/:kind/:name to return an event-stream

2021-07-05 14:20:41 +02:00

CHANGELOG.md

Version Packages

2021-07-01 09:06:13 +00:00

config.d.ts

Update copyright headers

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

package.json

Provide a Drawer component to follow a running build

2021-07-05 14:20:41 +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).