Files

T

Himanshu Mishra a212e43142 techdocs: Add JSON Schema config

Show better error if techdocs.builder is set to 'ci' and if no docs are found.
Return 404 from googleStorage client when a file is not found.

2020-12-05 10:48:54 +01:00

dev

techdocs: Use EntityName from catalog-model as Entity type

2020-11-28 20:02:40 +01:00

src

techdocs: Add JSON Schema config

2020-12-05 10:48:54 +01:00

.eslintrc.js

feat(techdocs): yarn create-plugin

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

CHANGELOG.md

Version Packages

2020-12-03 15:28:22 +00:00

package.json

techdocs: Add JSON Schema config

2020-12-05 10:48:54 +01:00

README.md

Updated docs for techdocs plugin (#2127 )

2020-08-27 09:52:49 +02:00

README.md

TechDocs Plugin

Getting started

Set up Backstage and TechDocs by follow our guide on Getting Started.

Configuration

Custom Storage URL

TechDocs will try to read your documentation from the URL you have specified in the techdocs storageUrl in app-config.yml.

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).