Files

T

Sebastian Qvarfordt d865f88344 [TechDocs] Rebuild docs if the github source is newer than last docs build (#2353 )

* Added age check for documentation in github to make sure it's up to date

* Updated failing tests

* Updated docs to explain requestUrl and storageUrl

* Updated failing tests

* Update packages/create-app/templates/default-app/app-config.yaml.hbs

* Update docs/features/techdocs/getting-started.md

Co-authored-by: Emma Indal <emmai@spotify.com>

2020-09-09 16:05:28 +02:00

dev

core-api: change ApiFactory.implements to .api

2020-09-08 11:31:48 +02:00

src

[TechDocs] Rebuild docs if the github source is newer than last docs build (#2353 )

2020-09-09 16:05:28 +02:00

.eslintrc.js

…

package.json

chore: bump mui to the create-app resolved version, to lose Accordion warnings

2020-09-09 11:18:18 +02: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).