Files

T

Matei David a5e27d5c1d Introduce techdocs metadata in techdocs-common

* Add TechdocsMetadata type in backend plugin endpoint
 * Introduce TechDocsMetadata type in frontend
 * Add changeset
 * Remove old thennable metadata resp
 * Address PR feedback
  - Remove explicit type annotation on TechDocsMetadata
  - Reintroduce res.send instead of throwing an error
  - Change logger info to logger error
 * Add TechDocsMetadata type in frontend plugin
 * Commit yarn.lock
 * Introduce JSON5 and remove parsing in local pub
Signed-off-by: Matei David <matei.david.35@gmail.com>

2021-01-16 18:33:53 +00:00

dev

techdocs: Use EntityName from catalog-model as Entity type

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

src

Introduce techdocs metadata in techdocs-common

2021-01-16 18:33:53 +00:00

.eslintrc.js

…

CHANGELOG.md

Version Packages

2021-01-14 13:05:31 +00:00

config.d.ts

Update plugins/techdocs/config.d.ts

2021-01-12 14:43:52 +01:00

package.json

Version Packages

2021-01-14 13:05:31 +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).