Niklas Aronsson
860765ff45
This patch adds a configuration option for setting the "local" techdocs target directory. The target directory can be set using the "techdocs.publisher.local.publishDirectory". This fixes two "TODOs" in the "plugins/techdocs-node/src/stages /publish/local.ts" file: * Use a more persistent storage than node_modules or /tmp directory. Make it configurable with techdocs.publisher.local.publishDirectory * Move the logic of setting staticDocsDir based on config over to fromConfig, and set the value as a class parameter. Signed-off-by: Niklas Aronsson <niklasar@axis.com>
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-node 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.