Files

T

Raghunandan Balachandran f9457c0dd4 Merge pull request #6455 from SDA-SE/feat/techdocs-no-crash-not-found

[TechDocs] Handle error responses in getTechDocsMetadata and `getEntityMetadata` such that `<TechDocsPageHeader>` doesn't throw errors.

2021-07-19 10:05:16 +02:00

dev

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

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

src

Refactor <TechDocsPageHeader/> to not use AsyncState as inputs

2021-07-15 10:20:12 +02:00

.eslintrc.js

…

api-report.md

Refactor <TechDocsPageHeader/> to not use AsyncState as inputs

2021-07-15 10:20:12 +02:00

CHANGELOG.md

Version Packages

2021-07-15 09:19:25 +00:00

config.d.ts

Update copyright headers

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

package.json

Version Packages

2021-07-15 09:19:25 +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).