Merge pull request #1837 from FabianKramm/master

improve docs

Author: FabianKramm

README.md

@@ -558,20 +558,20 @@ deployments:
 
 dev:
   ports:
-    imageName: backend
+    imageSelector: ${runtime.images.backend}
     forward:
     - port: 3000
     - port: 8080
       remotePort: 80
   open:
   - url: http://localhost:3000/login
   sync:
-  - imageName: backend
+  - imageSelector: ${runtime.images.backend}
     localSubPath: ./src
   terminal:
-    imageName: backend
+    imageSelector: ${runtime.images.backend}
   replacePods:
-  - imageName: backend
+  - imageSelector: ${runtime.images.backend}
     replaceImage: loftsh/javascript:latest
 
 dependencies:

docs/pages/configuration/dependencies/git-repository.mdx

@@ -36,7 +36,7 @@ dependencies:
     ports: true
 dev:
   terminal:
-    imageName: api-server.server-image
+    imageSelector: ${runtime.dependencies.api-server.images.server-image}
 ```
 
 :::info Authentication

docs/pages/configuration/variables/runtime-variables.mdx

@@ -73,7 +73,7 @@ dev:
   # Will open a terminal to the pod with the 
   # image from dep1
   terminal:
-    imageName: ${runtime.dependencies.dep1.images.image1}
+    imageSelector: ${runtime.dependencies.dep1.images.image1}
 ```
 
 </TabItem>
@@ -124,5 +124,5 @@ dev:
   # Will open a terminal to the pod with the 
   # image from dep1
   terminal:
-    imageName: ${runtime.dependencies.dep1.images.image1}
+    imageSelector: ${runtime.dependencies.dep1.images.image1}
 ```

docs/versioned_docs/version-4.13/configuration/images/prefer-sync-over-rebuild.mdx

@@ -36,7 +36,7 @@ images:
     image: dscr.io/${DEVSPACE_USERNAME}/cache
 dev:
   sync:
-  - imageName: backend
+  - imageSelector: backend
     onUpload:
       restartContainer: true
 ```

docs/versioned_docs/version-5.18/commands/devspace_sync.md

@@ -44,8 +44,11 @@ devspace sync --container-path=/my-path
       --no-watch                   Synchronizes local and remote and then stops
       --pick                       Select a pod (default true)
       --pod string                 Pod to sync to
+      --polling bool               If polling should be used to detect file changes in the container
       --upload-only                If set DevSpace will only upload files
       --verbose                    Shows every file that is synced
+      --wait                       Wait for the pod(s) to start if they are not running
+
 ```
 
 
@@ -69,4 +72,3 @@ devspace sync --container-path=/my-path
       --var strings                  Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
       --vars-secret string           The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars")
 ```
-

docs/versioned_docs/version-5.18/configuration/dependencies/git-repository.mdx

@@ -36,7 +36,7 @@ dependencies:
     ports: true
 dev:
   terminal:
-    imageName: api-server.server-image
+    imageSelector: ${runtime.dependencies.api-server.images.server-image}
 ```
 
 :::info Authentication

docs/versioned_docs/version-5.18/configuration/variables/runtime-variables.mdx

@@ -73,7 +73,7 @@ dev:
   # Will open a terminal to the pod with the 
   # image from dep1
   terminal:
-    imageName: ${runtime.dependencies.dep1.images.image1}
+    imageSelector: ${runtime.dependencies.dep1.images.image1}
 ```
 
 </TabItem>
@@ -124,5 +124,5 @@ dev:
   # Will open a terminal to the pod with the 
   # image from dep1
   terminal:
-    imageName: ${runtime.dependencies.dep1.images.image1}
+    imageSelector: ${runtime.dependencies.dep1.images.image1}
 ```

docs/versioned_docs/version-5.18/configuration/variables/source-command.mdx

@@ -88,4 +88,26 @@ vars:
 
 ### `default`
 
-If the command returns nothing, this is the value that will be used for this variable.
+If the command returns nothing, this is the value that will be used for this variable.
+
+### `alwaysResolve`
+
+If enabled, the variable will be loaded even though it is not used within the config. This might be useful for variables that should be resolved after a config expression is applied. E.g.:
+
+`devspace.yaml`:
+```
+vars:
+- name: my-var
+  value: my-value
+  alwaysResolve: true
+hooks:
+- name: my-hook
+  command: $(cat command.txt)
+  events: ["after:deploy"]
+```
+
+`command.txt`:
+```
+echo Hello ${my-var}!
+```
+

docs/versioned_docs/version-5.18/configuration/variables/source-env.mdx

@@ -34,3 +34,24 @@ If `source` is `env` and the environment variable is **not** defined, DevSpace w
 ### `default`
 
 <FragmentVarsDefault/>
+
+### `alwaysResolve`
+
+If enabled, the variable will be loaded even though it is not used within the config. This might be useful for variables that should be resolved after a config expression is applied. E.g.:
+
+`devspace.yaml`:
+```
+vars:
+- name: my-var
+  value: my-value
+  alwaysResolve: true
+hooks:
+- name: my-hook
+  command: $(cat command.txt)
+  events: ["after:deploy"]
+```
+
+`command.txt`:
+```
+echo Hello ${my-var}!
+```

docs/versioned_docs/version-5.18/configuration/variables/source-input.mdx

@@ -177,3 +177,24 @@ If the provided value does **<u>not</u>** match the regex in `validationPattern`
 
 ### `validationMessage`
 The `validationMessage` option expects a string stating an error message that is shown to the user when providing a value for the variable that does not match the regex provided in [`validationPattern`](#validationpattern).
+
+### `alwaysResolve`
+
+If enabled, the variable will be loaded even though it is not used within the config. This might be useful for variables that should be resolved after a config expression is applied. E.g.:
+
+`devspace.yaml`:
+```
+vars:
+- name: my-var
+  value: my-value
+  alwaysResolve: true
+hooks:
+- name: my-hook
+  command: $(cat command.txt)
+  events: ["after:deploy"]
+```
+
+`command.txt`:
+```
+echo Hello ${my-var}!
+```