techdocs: Use 'local' and 'external' for alternatives for techdocs.builder config

Co-authored-by: freben <freben@gmail.com>
This commit is contained in:
Himanshu Mishra
2020-12-09 12:31:40 +01:00
parent fc697b87c5
commit 9bd130a73a
6 changed files with 16 additions and 15 deletions
@@ -121,8 +121,8 @@ export async function createRouter({
}
// techdocs-backend will only try to build documentation for an entity if techdocs.builder is set to 'local'
// If set to 'ci', it will only try to fetch and assume that that CI/CD pipeline of the repository hosting the
// entity's documentation is responsible for building and publishing documentation to the storage provider.
// If set to 'external', it will only try to fetch and assume that an external process (e.g. CI/CD pipeline
// of the repository) is responsible for building and publishing documentation to the storage provider.
if (config.getString('techdocs.builder') === 'local') {
const docsBuilder = new DocsBuilder({
preparers,