Merge pull request #2025 from jschalz/v6-docs-dev

[WIP] v6 Docs Dev (jschalz)

Author: LukasGentele

docs/pages/_partials/command_is_command.mdx

@@ -2,19 +2,19 @@ The function `is_command` checks if a given argument is a command in DevSpace.
 
 ## Arguments
 
-### `[command]`
+### `[DevSpace command]`
 
 ```
 is_command [command]
 ```
 
 ### Example
 
-TODO: Fix example
-
 ```yaml
 pipelines:
   dev:
     run: |-
-      is_command
+      if is_command dev; then
+        start_dev --all
+      fi
 ```

docs/pages/_partials/command_is_os.mdx

@@ -10,11 +10,11 @@ is_os [os]
 
 ### Example
 
-TODO: Fix example
-
 ```yaml
 pipelines:
   dev:
     run: |-
-      is_os
+      if is_os windows; then
+        echo "Running on Windows!"
+      fi
 ```

docs/pages/_partials/command_run_watch.mdx

@@ -1,13 +1,13 @@
-TODO: run_watch one-liner description
+The function `run_watch` takes in a path to watch and a subcommand to run on that path.
 
 ## Arguments
 
 ### `--fail-on-error`
 
-If true, the command will fail on an error while running the sub command.
+If true, the command will fail on an error while running the subcommand.
 
 ```
-run_watch --path MY_PATH -- my_command
+run_watch --path [MY_PATH] -- [my_command]
 ```
 
 ### `--path`, `-p`
@@ -19,11 +19,9 @@ The paths to watch. Can be patterns in the form of `./**/my-file.txt`.
 
 ### Example
 
-TODO: Fix example
-
 ```yaml
-pipelines:
-  dev:
-    run: |-
-      run_watch
+commands:
+  # Overwrites dev
+  dev: |-
+    run_watch -p devspace.yaml -p *.go -- devspace run-pipeline dev $@
 ```

docs/pages/_partials/command_xargs.mdx

@@ -1,5 +1,3 @@
-//TODO: Lukas/Fabian, what does this function look like in action?
-
 The function `xargs` allows a user to overwrite current flags and utilities.
 
 ## Usage
@@ -12,11 +10,9 @@ xargs [utility [argument ...]]
 
 ### Example
 
-TODO: Fix example
-
 ```yaml
 pipelines:
   dev:
     run: |-
-      xargs 
+      echo [image1] [image2] | xargs build_images
 ```

docs/pages/configuration/dependencies/basics.mdx

@@ -25,7 +25,7 @@ Dependencies for DevSpace projects are defined within the `dependencies` section
 
 ```yaml
 dependencies:
-- name: api-server 
+- name: api-server
   source:
     git: https://github.com/my-api-server
     branch: stable
@@ -114,7 +114,7 @@ dependencies:
   source:
     path: dep1
 dev:
-  # Will open a terminal to the pod with the 
+  # Will open a terminal to the pod with the
   # image from dep1
   terminal:
     imageSelector: ${runtime.dependencies.dep1.images.image1}
@@ -136,7 +136,7 @@ deployments:
 
 ### Referencing Dependencies in Deployment Values / Manifests
 
-It is also possible to reference a dependency's image with [runtime variables](../variables/runtime-variables.mdx) in a deployment:
+It is also possible to reference a dependency's image with [runtime variables](../variables/built-in.mdx) in a deployment:
 ```yaml
 dependencies:
 - name: dep1
@@ -148,7 +148,7 @@ deployments:
       componentChart: true
       values:
         containers:
-          - image: ${runtime.dependencies.dep1.image1.image}:${runtime.dependencies.dep1.image1.tag} # -> replaced with 'myusername/devspace:xxxx' 
+          - image: ${runtime.dependencies.dep1.image1.image}:${runtime.dependencies.dep1.image1.tag} # -> replaced with 'myusername/devspace:xxxx'
 ```
 
 With a dependency `dep1/devspace.yaml` that looks like:

docs/pages/configuration/deployments/helm/basics.mdx

@@ -47,7 +47,7 @@ deployments:
         name: chart-name
         repo: https://my-charts.company.tld/
       values:
-        # If registry.url/repo/image was found under images as well, will be 
+        # If registry.url/repo/image was found under images as well, will be
         # rewritten to registry.url/repo/image:generated_tag
         imageWithTag: registry.url/repo/image
         # If registry.url/repo/image was found under images.app as well, will be
@@ -135,7 +135,7 @@ deployments:
 ```
 
 ### `updateImageTags`
-The `updateImageTags` option expects a boolean stating if DevSpace should do [Image Tag Replacement](../../configuration/deployments/basics.mdx#3-tag-replacement).
+The `updateImageTags` option expects a boolean stating if DevSpace should do [Image Tag Replacement](../basics.mdx#3-tag-replacement).
 
 When set to `true`, DevSpace searches all your values (specified via `values` or `valuesFiles`) for images that are defined in the `images` section of the `devspace.yaml`. If DevSpace finds an image, it replaces or appends the image tag with the tag it created during the image building process. Image tag replacement makes sure that your application will always be started with the most up-to-date image that DevSpace has built for you.
 
@@ -201,8 +201,8 @@ deployments:
       chart:
         name: bitnami/mysql
 ```
-**Explanation:**  
-Deploying the above example would roughly be equivalent to this command:
+**Explanation:**
+Deploying the above example is roughly equivalent to this command:
 ```bash
 helm install database bitnami/mysql
 ```
@@ -228,8 +228,8 @@ deployments:
         name: bitnami/mysql
         version: "1.3.1"
 ```
-**Explanation:**  
-Deploying the above example would roughly be equivalent to this command:
+**Explanation:**
+Deploying the above example is roughly equivalent to this command:
 ```bash
 helm install database bitnami/mysql --version="1.3.1"
 ```
@@ -246,8 +246,8 @@ deployments:
         name: custom-chart
         repo: https://my-repo.tld/
 ```
-**Explanation:**  
-Deploying the above example would roughly be equivalent to this command:
+**Explanation:**
+Deploying the above example is roughly equivalent to this command:
 ```bash
 helm install database custom-chart --repo "https://my-repo.tld/"
 ```
@@ -266,7 +266,7 @@ The `values` option expects an object with values that should be overriding the
 
 Compared to the `valuesFiles` option, using `values` has the following advantages:
 - It is easier to comprehend and faster to find (no references)
-- It allows you to use [dynamic config variables](../../configuration/variables/basics.mdx)
+- It allows you to use [dynamic config variables](../../variables/basics.mdx)
 
 :::info
 Because both, `values` and `valuesFiles`, have advantages and disadvantages, it is often useful to combine them. When setting both, values defined in `values` have precedence over values defined in `valuesFiles`.
@@ -289,8 +289,8 @@ deployments:
         mysqlUser: db_user
         mysqlDatabase: app_database
 ```
-**Explanation:**  
-Deploying the above example would roughly be equivalent to this command:
+**Explanation:**
+Deploying the above example is roughly equivalent to this command:
 ```bash
 helm install database bitnami/mysql --set mysqlRootPassword="$MYSQL_ROOT_PASSWORD" --set mysqlUser="db_user" --set mysqlDatabase="app_database"
 ```
@@ -322,8 +322,8 @@ deployments:
       - mysql/values.yaml
       - mysql/values.production.yaml
 ```
-**Explanation:**  
-Deploying the above example would roughly be equivalent to this command:
+**Explanation:**
+Deploying the above example is roughly equivalent to this command:
 ```bash
 helm install database bitnami/mysql -f mysql/values.yaml -f mysql/values.production.yaml
 ```
@@ -349,8 +349,8 @@ deployments:
         name: bitnami/mysql
 ```
 
-**Explanation:**  
-Deploying the above example would print the helm output and the `notes.txt` from the bitnami/mysql chart.
+**Explanation:**
+Deploying the above example prints the helm output and the `notes.txt` from the bitnami/mysql chart.
 
 ### `templateArgs`
 The `templateArgs` specifies an array of arguments that will be passed by devspace additionally to the standard arguments to `helm template` during `devspace render`.

docs/pages/configuration/dev/basics.mdx

@@ -19,7 +19,7 @@ Kubernetes-based development can be useful in the following cases:
 - You want to test your application in a production-like environment
 - You want to debug issues that are hard to reproduce on your local machine
 
-The development experience is very similar to using `docker-compose`, so if you are already familiar on how to develop with `docker-compose`, DevSpace will behave very similar. One of the major benefits of DevSpace versus docker-compose is that DevSpace allows you to develop in any Kubernetes cluster, either locally using minikube, Docker Kubernetes etc. or in any remote Kubernetes cluster.
+The development experience is very similar to using `docker-compose`. If you are already familiar with how to develop with `docker-compose`, DevSpace will behave very similar. One of the benefits of DevSpace versus `docker-compose` is that DevSpace allows you to develop in any Kubernetes cluster, either locally using minikube, Docker Kubernetes etc., or in any remote Kubernetes cluster.
 
 
 ## Start Development Mode
@@ -93,7 +93,7 @@ DevSpace provides two options to develop applications in Kubernetes:
 :::note Multi-Container Log Streaming (default)
 The first option starts your application as defined in your Dockerfile or in your Kubernetes pod definition. After the pods are started, DevSpace streams the logs of all containers that are started with an image that was built during the image building process. Each log line is prefixed with the image name or alternatively with the pod name of the container. Before starting the actual log streaming, DevSpace prints the last 50 log lines of each container by default.
 
-Learn how to [customize which containers should be included in the log stream and how many log lines should be shown in the beginning](../../configuration/development/log-streaming.mdx).
+Learn how to [customize which containers should be included in the log stream and how many log lines should be shown in the beginning](../../configuration/dev/workflow/log-streaming.mdx).
 :::
 
 :::note Terminal Session
@@ -103,15 +103,15 @@ devspace dev -t
 ```
 Instead of starting the multi-container log streaming, you can also start development mode using a terminal session.
 
-Terminal is configurable by [using the `dev.terminal` configuration section](../../configuration/development/terminal.mdx).
+Terminal is configurable by [using the `dev.terminal` configuration section](../../configuration/dev/workflow/terminal.mdx).
 :::
 
 ### 8. Open Links (optional)
 DevSpace iterates over every item in the `dev.open` array defined in the `devspace.yaml` and tries to open the URL you provide for each item using the following method:
 
 <FragmentWorkflowOpenLinks/>
 
-Learn more about [configuring auto-opening links](../../configuration/development/open-links.mdx).
+Learn more about [configuring auto-opening links](../../configuration/dev/workflow/open.mdx).