docs: add function / option documentation

FabianKramm · FabianKramm · commit 0e1efa8da827 · 2022-09-01T19:59:07.000+02:00
diff --git a/devspace-schema.json b/devspace-schema.json
@@ -1813,6 +1813,10 @@
         "disableScreen": {
           "type": "boolean",
           "description": "DisableScreen will disable screen which is used by DevSpace by default to preserve\nsessions if connections interrupt or the session is lost."
+        },
+        "disableTTY": {
+          "type": "boolean",
+          "description": "DisableTTY will disable a tty shell for terminal command execution"
         }
       },
       "type": "object",
diff --git a/docs/pages/configuration/_partials/functions/group_other.mdx b/docs/pages/configuration/_partials/functions/group_other.mdx
@@ -9,9 +9,11 @@ import PartialGetflag from "./get_flag.mdx"
 import PartialCat from "./cat.mdx"
 import PartialGetconfigvalue from "./get_config_value.mdx"
 import PartialExeccontainer from "./exec_container.mdx"
+import PartialWaitpod from "./wait_pod.mdx"
 import PartialSelectpod from "./select_pod.mdx"
 
 <PartialSelectpod />
+<PartialWaitpod />
 <PartialExeccontainer />
 <PartialGetconfigvalue />
 <PartialCat />
diff --git a/docs/pages/configuration/_partials/functions/group_other_pipeline.mdx b/docs/pages/configuration/_partials/functions/group_other_pipeline.mdx
@@ -4,9 +4,11 @@
 
 import PartialGetconfigvalue from "./get_config_value.mdx"
 import PartialExeccontainer from "./exec_container.mdx"
+import PartialWaitpod from "./wait_pod.mdx"
 import PartialSelectpod from "./select_pod.mdx"
 
 <PartialSelectpod />
+<PartialWaitpod />
 <PartialExeccontainer />
 <PartialGetconfigvalue />
 
diff --git a/docs/pages/configuration/_partials/functions/wait_pod.mdx b/docs/pages/configuration/_partials/functions/wait_pod.mdx
@@ -0,0 +1,26 @@
+
+import PartialImageselector from "./wait_pod/image-selector.mdx"
+import PartialLabelselector from "./wait_pod/label-selector.mdx"
+import PartialContainer from "./wait_pod/container.mdx"
+import PartialNamespace from "./wait_pod/namespace.mdx"
+import PartialDisablewait from "./wait_pod/disable-wait.mdx"
+import PartialTimeout from "./wait_pod/timeout.mdx"
+
+<details className="config-field -function" data-expandable="true">
+<summary>
+
+### `wait_pod` <span className="config-field-type">[command]</span> <span className="config-field-enum"></span> <span className="config-field-default -return"></span> <span className="config-field-required" data-required="true">pipeline only</span>  {#wait_pod}
+
+Waits for a pod to become running
+
+</summary>
+
+<PartialImageselector />
+<PartialLabelselector />
+<PartialContainer />
+<PartialNamespace />
+<PartialDisablewait />
+<PartialTimeout />
+
+
+</details>
diff --git a/docs/pages/configuration/_partials/functions/wait_pod/container.mdx b/docs/pages/configuration/_partials/functions/wait_pod/container.mdx
@@ -0,0 +1,13 @@
+
+<details className="config-field -function" data-expandable="false">
+<summary>
+
+#### `--container` <span className="config-field-type">string</span> <span className="config-field-enum"></span> <span className="config-field-default -return"></span> <span className="config-field-required" data-required="false">pipeline only</span>  {#wait_pod-container}
+
+The container to use
+
+</summary>
+
+
+
+</details>
diff --git a/docs/pages/configuration/_partials/functions/wait_pod/disable-wait.mdx b/docs/pages/configuration/_partials/functions/wait_pod/disable-wait.mdx
@@ -0,0 +1,13 @@
+
+<details className="config-field -function" data-expandable="false">
+<summary>
+
+#### `--disable-wait` <span className="config-field-type">bool</span> <span className="config-field-enum"></span> <span className="config-field-default -return"></span> <span className="config-field-required" data-required="false">pipeline only</span>  {#wait_pod-disable-wait}
+
+If true, will not wait for the container to become ready
+
+</summary>
+
+
+
+</details>
diff --git a/docs/pages/configuration/_partials/functions/wait_pod/image-selector.mdx b/docs/pages/configuration/_partials/functions/wait_pod/image-selector.mdx
@@ -0,0 +1,13 @@
+
+<details className="config-field -function" data-expandable="false">
+<summary>
+
+#### `--image-selector` <span className="config-field-type">string</span> <span className="config-field-enum"></span> <span className="config-field-default -return"></span> <span className="config-field-required" data-required="false">pipeline only</span>  {#wait_pod-image-selector}
+
+The image selector to use to select the container
+
+</summary>
+
+
+
+</details>
diff --git a/docs/pages/configuration/_partials/functions/wait_pod/label-selector.mdx b/docs/pages/configuration/_partials/functions/wait_pod/label-selector.mdx
@@ -0,0 +1,13 @@
+
+<details className="config-field -function" data-expandable="false">
+<summary>
+
+#### `--label-selector` <span className="config-field-type">string</span> <span className="config-field-enum"></span> <span className="config-field-default -return"></span> <span className="config-field-required" data-required="false">pipeline only</span>  {#wait_pod-label-selector}
+
+The label selector to use to select the container
+
+</summary>
+
+
+
+</details>
diff --git a/docs/pages/configuration/_partials/functions/wait_pod/namespace.mdx b/docs/pages/configuration/_partials/functions/wait_pod/namespace.mdx
@@ -0,0 +1,13 @@
+
+<details className="config-field -function" data-expandable="false">
+<summary>
+
+#### `--namespace / -n` <span className="config-field-type">string</span> <span className="config-field-enum"></span> <span className="config-field-default -return"></span> <span className="config-field-required" data-required="false">pipeline only</span>  {#wait_pod-namespace}
+
+The namespace to use
+
+</summary>
+
+
+
+</details>
diff --git a/docs/pages/configuration/_partials/functions/wait_pod/timeout.mdx b/docs/pages/configuration/_partials/functions/wait_pod/timeout.mdx
@@ -0,0 +1,13 @@
+
+<details className="config-field -function" data-expandable="false">
+<summary>
+
+#### `--timeout` <span className="config-field-type">int64</span> <span className="config-field-enum"></span> <span className="config-field-default -return"></span> <span className="config-field-required" data-required="false">pipeline only</span>  {#wait_pod-timeout}
+
+The timeout to wait. Defaults to 5 minutes
+
+</summary>
+
+
+
+</details>
diff --git a/docs/pages/configuration/_partials/v2beta1/dev/containers/terminal/disableTTY.mdx b/docs/pages/configuration/_partials/v2beta1/dev/containers/terminal/disableTTY.mdx
@@ -0,0 +1,13 @@
+
+<details className="config-field" data-expandable="false" open>
+<summary>
+
+##### `disableTTY` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">boolean</span> <span className="config-field-default">false</span> <span className="config-field-enum"></span> {#dev-containers-terminal-disableTTY}
+
+DisableTTY will disable a tty shell for terminal command execution
+
+</summary>
+
+
+
+</details>
diff --git a/docs/pages/configuration/_partials/v2beta1/dev/containers/terminal_reference.mdx b/docs/pages/configuration/_partials/v2beta1/dev/containers/terminal_reference.mdx
@@ -4,6 +4,7 @@ import PartialWorkDir from "./terminal/workDir.mdx"
 import PartialEnabled from "./terminal/enabled.mdx"
 import PartialDisableReplace from "./terminal/disableReplace.mdx"
 import PartialDisableScreen from "./terminal/disableScreen.mdx"
+import PartialDisableTTY from "./terminal/disableTTY.mdx"
 
 <PartialCommand />
 
@@ -18,3 +19,6 @@ import PartialDisableScreen from "./terminal/disableScreen.mdx"
 
 
 <PartialDisableScreen />
+
+
+<PartialDisableTTY />
diff --git a/docs/pages/configuration/_partials/v2beta1/dev/terminal/disableTTY.mdx b/docs/pages/configuration/_partials/v2beta1/dev/terminal/disableTTY.mdx
@@ -0,0 +1,13 @@
+
+<details className="config-field" data-expandable="false" open>
+<summary>
+
+#### `disableTTY` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">boolean</span> <span className="config-field-default">false</span> <span className="config-field-enum"></span> {#dev-terminal-disableTTY}
+
+DisableTTY will disable a tty shell for terminal command execution
+
+</summary>
+
+
+
+</details>
diff --git a/docs/pages/configuration/_partials/v2beta1/dev/terminal_reference.mdx b/docs/pages/configuration/_partials/v2beta1/dev/terminal_reference.mdx
@@ -4,6 +4,7 @@ import PartialWorkDir from "./terminal/workDir.mdx"
 import PartialEnabled from "./terminal/enabled.mdx"
 import PartialDisableReplace from "./terminal/disableReplace.mdx"
 import PartialDisableScreen from "./terminal/disableScreen.mdx"
+import PartialDisableTTY from "./terminal/disableTTY.mdx"
 
 <PartialCommand />
 
@@ -18,3 +19,6 @@ import PartialDisableScreen from "./terminal/disableScreen.mdx"
 
 
 <PartialDisableScreen />
+
+
+<PartialDisableTTY />
diff --git a/docs/schemas/config-openapi.json b/docs/schemas/config-openapi.json
@@ -1821,6 +1821,10 @@
               "disableScreen": {
                 "type": "boolean",
                 "description": "DisableScreen will disable screen which is used by DevSpace by default to preserve\nsessions if connections interrupt or the session is lost."
+              },
+              "disableTTY": {
+                "type": "boolean",
+                "description": "DisableTTY will disable a tty shell for terminal command execution"
               }
             },
             "type": "object",
