Files

T

blam 101978963d Merge branch 'master' of github.com:spotify/backstage into migrate-to-msw

* 'master' of github.com:spotify/backstage: (139 commits)
  Cleanup
  Update PinButton.test.tsx
  feat: update github insights plugin version (#2973)
  Ignore IntelliJ *.iml files (#2971)
  chore(deps): bump rollup-plugin-dts from 1.4.11 to 1.4.13
  fix the plugin card on plugins page
  align 'Add to Marketplace' button on plugins page
  fix the PluginGrid on mobiles sizes
  use getBy query instead of queryBy when asserting for elements present in document (#2951)
  Update PinButton.tsx
  Add test case for Progress component (#2953)
  fix the styling of footer copy on mobile
  add changeset
  handle the case where no entities are available to show
  core-api: work around issue with ApiRef export const declarations
  core-api: move utility api system implementation into apis/system
  Update docs regarding npm config ignore-scripts flag
  Another try
  Fix Core Features configuration id (#2948)
  Fix test?
  ...

2020-10-19 23:57:40 +02:00

dev

core-api: change ApiFactory.implements to .api

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

src

Merge branch 'master' of github.com:spotify/backstage into migrate-to-msw

2020-10-19 23:57:40 +02:00

.eslintrc.js

…

package.json

Merge branch 'master' of github.com:spotify/backstage into migrate-to-msw

2020-10-13 03:56:13 +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).