Docs Generator

Pipeline markdown documentation generator.

Options

Specify the options below to configure the Docs generator:

Name	Description
docGenerate	Load markdown files
docConfigRepoName	Config repo name
docConfigRepoBranch	Config branch name
docModulesRepoName	Modules repo name
docModulesRepoBranch	Modules branch name
docModulesInputPath	Folder to scan for pipeline modules
docAppsInputPath	Folder to scan for app modules
docConfigInputPath	Folder to scan for pipeline modules
docSiteOutputPath	Site folder to output markdown to
docApiFile	Path to js api md
docGithubAPIKey	GitHub api key

docGenerate

Load markdown files.

Type	Required
Boolean	✔

Load pipeline markdown (.md) 'doc' file setting for which to generate docs.

docConfigRepoName

Config repo name.

Type	Required
String	✔

Name of config github repository to link for pipeline configuration.

docConfigRepoBranch

Config branch name.

Type	Required
String	✔

Name of branch in config github repository to link for pipeline configuration.

docModulesRepoName

Modules repo name.

Type	Required
String	✔

Name of modules github repository to link for pipeline modules.

docModulesRepoBranch

Modules branch name.

Type	Required
String	✔

Name of branch in modules github repository to link for pipeline configuration.

docModulesInputPath

Folder to scan for pipeline modules.

Type	Required
String	✔

Folder to scan for pipeline units and modules to generate markdown docs for.

docAppsInputPath

Folder to scan for app modules.

Type	Required
String	✔

Folder to scan for app modules to generate markdown docs for.

docConfigInputPath

Folder to scan for pipeline modules.

Type	Required
String	✔

Folder to scan for pipeline unit and module config files to generate markdown docs for.

docSiteOutputPath

Site folder to output markdown to.

Type	Required
String	✔

Folder to write for pipeline components markdown docs to.

docApiFile

Path to js api md.

Type	Required
String	✔

Path to js api md.

docGithubAPIKey

GitHub api key.

Type	Default
String	""

For validating GitHub links.

This unit is defined in generate/unit.yaml.