blam
b33353dd39
* 'master' of github.com:spotify/backstage: (110 commits) chore(catalog-backend): removing redudant classes and some functions chore(deps-dev): bump @types/webpack from 4.41.21 to 4.41.22 (#2765) move codecov.yml to .github feat(catalog-backend): add batch concurrency create-app: remove build step cli: simplify jest transform ignore regex feat(catalog-backend): introduce batching, speed up reading and writing of large datasets Techdocs: add Azure DevOps prepare support (#2748) feat(techdocs-header): Show breadcrumbs on docs page (#2786) changesets: add entry for create-app template location fix create-app: revert to github location type for example templates fix: make catalog filter work again Use new url scheme for techdocs feat: remove LocationProcessor.processEntity Add Dockerfile for helm chart feat: use the new UrlReader in the CodeOwnersProcessor feat: use new UrlReader in PlaceholderProcessor feat: remove the backstage.io/definition-at-location annotation Update loud-lamps-visit.md feat(proxy-backend): limit the forwarded http headers to a safe set ...
techdocs-backend
This is the backend part of the techdocs plugin.
Getting Started
This backend plugin can be started in a standalone mode from directly in this package
with yarn start. However, it will have limited functionality and that process is
most convenient when developing the techdocs backend plugin itself.
To evaluate TechDocs and have a greater amount of functionality available, instead do
# in one terminal window, run this from from the very root of the Backstage project
cd packages/backend
yarn start
What techdocs-backend does
This plugin is the backend part of the techdocs plugin. It provides building and serving of your docs without having to use another service and hosting provider. To use it set your techdocs storageUrl in your app-config.yml to http://localhost:7000/api/techdocs/static/docs.
techdocs:
storageUrl: http://localhost:7000/api/techdocs/static/docs
Extending techdocs-backend
Currently the build process of techdocs-backend is split up in these three stages.
- Preparers
- Generators
- Publishers
Preparers read your entity data and creates a working directory with your documentation source code. For example if you have set your backstage.io/techdocs-ref to github:https://github.com/spotify/backstage.git it will clone that repository to a temp folder and pass that on to the generator.
Generators takes the prepared source and runs the techdocs-container on it. It then passes on the output folder of that build to the publisher.
Publishers gets a folder path from the generator and publish it to your storage solution. Currently the only built in storage solution is a folder called static/docs inside the techdocs-backend plugin.
Any of these can be extended. If we want to publish to a external static file server using rsync for example that can be done by creating a rsync publisher. (Keep in mind that if you want techdocs-backend to initiate a build this would also require techdocs-backend to act as a proxy, which is not yet implemented.)