paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 31 Packages Projects Releases Wiki Activity

Merge pull request #3718 from backstage/orkohunter/update-techdocs-project-status-docs

Browse Source
This commit is contained in:
Himanshu Mishra
2020-12-16 16:25:13 +01:00
committed by GitHub
parent d62be2f822 eb39a633e8
commit d96f61bd70
5 changed files with 273 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/backend/src/plugins/techdocs.ts
+10 -4
View File
@@ -32,10 +32,7 @@ export default async function createPlugin({
discovery,
reader,
}: PluginEnvironment) {
const generators = new Generators();
const techdocsGenerator = new TechdocsGenerator(logger, config);
generators.register('techdocs', techdocsGenerator);
// Preparers are responsible for fetching source files for documentation.
const preparers = new Preparers();
const directoryPreparer = new DirectoryPreparer(logger);
@@ -49,8 +46,17 @@ export default async function createPlugin({
const urlPreparer = new UrlPreparer(reader, logger);
preparers.register('url', urlPreparer);
// Generators are used for generating documentation sites.
const generators = new Generators();
const techdocsGenerator = new TechdocsGenerator(logger, config);
generators.register('techdocs', techdocsGenerator);
// Publishers are used for
// 1. Publishing generated files to storage
// 2. Fetching files from storage and passing them to TechDocs frontend.
const publisher = Publisher.fromConfig(config, logger, discovery);
// Docker client used by the generators.
const dockerClient = new Docker();
return await createRouter({