Nikolas Skoufis
2a865343c2
This adds a new interface called DocsBuildStrategy. This strategy allows for different answers to the question: should the TechDocs backend perform a build of the given entity? The default implementation replicates the existing functionality, in that if the techdocs.builder config value is set to local, then we do trigger builds, and if the value is set to anything else, we don't trigger builds. However the strategy has access to the entity, and so more complex strategies are possible. This strategy is added as an optional parameter on the RouterOptions types, and defaults to the DefaultDocsBuildStrategy if unspecified, allowing for backwards compatibility. TODO: rename some of the config options, and reword errors to reflect the new interface Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au>
techdocs-backend
This is the backend part of the techdocs plugin.
Getting Started
This backend plugin can be started in a standalone mode directly from in this package
using 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:
# From your Backstage root directory
cd packages/backend
yarn start
What techdocs-backend does
This provides serving and building of documentation for any entity. To configure various storage providers and building options, see http://backstage.io/docs/features/techdocs/configuration.
The techdocs-backend re-exports the techdocs-common package which has the features to prepare, generate and publish docs. The Publishers are also used to fetch the static documentation files and render them in TechDocs.