paulononato/backstage

Files

T

History

github-actions[bot] c734d6995a Version Packages

2021-08-12 08:21:56 +00:00

..

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

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

feat(techdocs): implement composable home page

2021-08-10 10:03:26 -04:00

.eslintrc.js

…

api-report.md

feat(techdocs): implement composable home page

2021-08-10 10:03:26 -04:00

CHANGELOG.md

Version Packages

2021-08-12 08:21:56 +00:00

config.d.ts

Update copyright headers

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

package.json

Version Packages

2021-08-12 08:21:56 +00: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).