Merge pull request #6071 from andrewthauer/techdocs-custom-docker

feat(techdocs-common): add custom docker image support
2021-07-15 10:39:14 +02:00
parent 4adf795ffb d5eaab91dd
commit 54c25db339
12 changed files with 303 additions and 32 deletions
@@ -29,7 +29,31 @@ export interface Config {
    /**
     * Techdocs generator information
     */
+    generator?: {
+      /**
+       * Where to run the techdocs (mkdocs) generator
+       */
+      runIn: 'local' | 'docker';
+
+      /**
+       * Override the default techdocs docker image
+       */
+      dockerImage?: string;
+
+      /**
+       * Pull the latest docker image
+       */
+      pullImage?: boolean;
+    };
+
+    /**
+     * Techdocs generator information
+     * @deprecated Replaced with techdocs.generator
+     */
    generators?: {
+      /**
+       * @deprecated Use techdocs.generator.runIn
+       */
      techdocs: 'local' | 'docker';
    };