Merge pull request #2662 from lianmakesthings/improve-docs

Improve docs

Author: lizardruss

cmd/flags/flags.go

@@ -44,7 +44,7 @@ func SetGlobalFlags(flags *flag.FlagSet) *GlobalFlags {
 		Flags: flags,
 	}
 
-	flags.StringVar(&globalFlags.OverrideName, "override-name", "", "If specified will override the devspace.yaml name")
+	flags.StringVar(&globalFlags.OverrideName, "override-name", "", "If specified will override the DevSpace project name provided in the devspace.yaml")
 	flags.BoolVar(&globalFlags.NoWarn, "no-warn", false, "If true does not show any warning when deploying into a different namespace or kube-context than before")
 	flags.BoolVar(&globalFlags.NoColors, "no-colors", false, "Do not show color highlighting in log output. This avoids invisible output with different terminal background colors")
 	flags.BoolVar(&globalFlags.Debug, "debug", false, "Prints the stack trace if an error occurs")

docs/pages/cli.md

@@ -26,8 +26,9 @@ DevSpace accelerates developing, deploying and debugging applications with Docke
       --kube-context string          The kubernetes context to use
       --kubeconfig string            The kubeconfig path to use
   -n, --namespace string             The kubernetes namespace to use
+      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
       --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
-      --override-name string         If specified will override the devspace.yaml name
+      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
   -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
       --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
   -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project

docs/pages/cli/devspace_add.md

@@ -33,8 +33,9 @@ Adds config sections to devspace.yaml
       --kube-context string          The kubernetes context to use
       --kubeconfig string            The kubeconfig path to use
   -n, --namespace string             The kubernetes namespace to use
+      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
       --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
-      --override-name string         If specified will override the devspace.yaml name
+      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
   -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
       --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
   -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project

docs/pages/cli/devspace_add_plugin.md

@@ -41,8 +41,9 @@ devspace add plugin https://github.com/my-plugin/plugin
       --kube-context string          The kubernetes context to use
       --kubeconfig string            The kubeconfig path to use
   -n, --namespace string             The kubernetes namespace to use
+      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
       --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
-      --override-name string         If specified will override the devspace.yaml name
+      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
   -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
       --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
   -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project

docs/pages/cli/devspace_analyze.md

@@ -47,8 +47,9 @@ devspace analyze --namespace=mynamespace
       --kube-context string          The kubernetes context to use
       --kubeconfig string            The kubeconfig path to use
   -n, --namespace string             The kubernetes namespace to use
+      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
       --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
-      --override-name string         If specified will override the devspace.yaml name
+      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
   -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
       --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
   -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project

docs/pages/cli/devspace_attach.md

@@ -48,8 +48,9 @@ devspace attach -n my-namespace
       --kube-context string          The kubernetes context to use
       --kubeconfig string            The kubeconfig path to use
   -n, --namespace string             The kubernetes namespace to use
+      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
       --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
-      --override-name string         If specified will override the devspace.yaml name
+      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
   -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
       --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
   -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project

docs/pages/cli/devspace_build.md

@@ -54,8 +54,9 @@ Builds all defined images and pushes them
       --kube-context string          The kubernetes context to use
       --kubeconfig string            The kubeconfig path to use
   -n, --namespace string             The kubernetes namespace to use
+      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
       --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
-      --override-name string         If specified will override the devspace.yaml name
+      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
   -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
       --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
   -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project

docs/pages/cli/devspace_cleanup.md

@@ -32,8 +32,9 @@ Cleans up resources
       --kube-context string          The kubernetes context to use
       --kubeconfig string            The kubeconfig path to use
   -n, --namespace string             The kubernetes namespace to use
+      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
       --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
-      --override-name string         If specified will override the devspace.yaml name
+      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
   -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
       --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
   -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project

docs/pages/cli/devspace_cleanup_images.md

@@ -38,8 +38,9 @@ Deletes all locally created docker images from docker
       --kube-context string          The kubernetes context to use
       --kubeconfig string            The kubeconfig path to use
   -n, --namespace string             The kubernetes namespace to use
+      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
       --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
-      --override-name string         If specified will override the devspace.yaml name
+      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
   -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
       --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
   -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project

docs/pages/cli/devspace_cleanup_local-registry.md

@@ -38,8 +38,9 @@ Deletes the local image registry
       --kube-context string          The kubernetes context to use
       --kubeconfig string            The kubeconfig path to use
   -n, --namespace string             The kubernetes namespace to use
+      --no-colors                    Do not show color highlighting in log output. This avoids invisible output with different terminal background colors
       --no-warn                      If true does not show any warning when deploying into a different namespace or kube-context than before
-      --override-name string         If specified will override the devspace.yaml name
+      --override-name string         If specified will override the DevSpace project name provided in the devspace.yaml
   -p, --profile strings              The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
       --silent                       Run in silent mode and prevents any devspace log output except panics & fatals
   -s, --switch-context               Switches and uses the last kube context and namespace that was used to deploy the DevSpace project