e44cb85b22
* 'master' of github.com:spotify/backstage: (66 commits) chore: fix lerna linting v0.1.1-alpha.25 Add Code Insights plugin to sample app and marketplace (#2833) Improve main CI build status badge in README (#2866) Update roadmap: Design System 🚢 (#2858) github/codecov: switch to informational mode github/workflows: use the tip of master as the base for comparing PR code coverage make saml provider path from globalConfig (#2855) fix(catalog-backend): limit search value lengths Update project Copyright (#2852) fix(catalog-backend): actually use modified entity output (default namespace was broken) remove unnecessary center keyword Move card header bg to up contrast, fix #2558 Update name of env authentication env vars Fix feedback from dtuite Remove chart testing workflow for now Only lint charts on Pull Requests Move the k8s deployment docs to its own helm deployment page Remove line in initdb script that creates backend db Use app-config.development.yaml to provide configuration instead of local ...
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).