Files

T

Ben Lambert 365a55372a Merge pull request #4868 from rbideau/4867-configure-aws-s3-endpoint

Add techdocs.publisher.awsS3.endpoint config option

2021-03-08 17:22:27 +01:00

dev

use token instead of idToken

2021-03-01 12:29:59 +01:00

src

Merge pull request #4675 from egnwd/techdocs/header-links

2021-03-08 13:21:43 +00:00

.eslintrc.js

…

CHANGELOG.md

Version Packages

2021-03-04 13:11:10 +00:00

config.d.ts

Add techdocs.publisher.awsS3.endpoint config option

2021-03-08 13:56:32 +01:00

package.json

chore(deps-dev): bump @types/node from 12.12.58 to 14.14.32

2021-03-08 13:19:08 +01: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).