refactor: add ide integration guide

Author: FabianKramm

devspace-schema.json

@@ -110,7 +110,7 @@
       "properties": {
         "name": {
           "type": "string",
-          "description": "Name is the name of the helm chart to deploy. Can also be a local path",
+          "description": "Name is the name of the helm chart to deploy. Can also be a local path or an oci url",
           "group": "repo",
           "group_name": "Source: Helm Repository"
         },
@@ -126,12 +126,12 @@
         },
         "username": {
           "type": "string",
-          "description": "Username is the username to authenticate to the chart repo",
+          "description": "Username is the username to authenticate to the chart repo. When using an OCI chart, used for registry auth",
           "group": "repo"
         },
         "password": {
           "type": "string",
-          "description": "Password is the password to authenticate to the chart repo",
+          "description": "Password is the password to authenticate to the chart repo, When using an OCI chart, used for registry auth",
           "group": "repo"
         },
         "path": {
@@ -1577,7 +1577,7 @@
         },
         "useInclude": {
           "type": "boolean",
-          "description": "UseInclude tells DevSpace to use a different file for ssh config"
+          "description": "UseInclude tells DevSpace to use a the file ~/.ssh/devspace_config for its ssh entries. DevSpace\nwill also create an import for its own entries inside ~/.ssh/config, this is a cleaner way,\nbut unfortunately not all SSH clients support this."
         }
       },
       "type": "object"
@@ -1695,6 +1695,10 @@
           "type": "boolean",
           "description": "NoWatch will terminate the sync after the initial sync is done"
         },
+        "file": {
+          "type": "boolean",
+          "description": "File signals DevSpace that this is a single file that should get synced instead of a whole directory"
+        },
         "printLogs": {
           "type": "boolean",
           "description": "PrintLogs defines if sync logs should be displayed on the terminal"

docs/pages/configuration/_partials/v2beta1/commands.mdx

@@ -7,7 +7,8 @@ import PartialCommandsreference from "./commands_reference.mdx"
 
 ## `commands` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">&lt;command_name&gt;:object</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands}
 
-Commands are custom commands that can be executed via 'devspace run COMMAND'. These commands are run within a pseudo bash that also allows executing special commands such as run_watch or is_equal.
+Commands are custom commands that can be executed via 'devspace run COMMAND'. These commands are run within a pseudo bash
+that also allows executing special commands such as run_watch or is_equal.
 
 </summary>
 
@@ -17,7 +18,7 @@ Commands are custom commands that can be executed via 'devspace run COMMAND'. Th
 
 ## `<command_name>` <span className="config-field-required" data-required="true">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands-name}
 
-Name is the name of a command that is used via 'devspace run NAME'.
+Name is the name of a command that is used via `devspace run NAME`
 
 </summary>
 

docs/pages/configuration/_partials/v2beta1/commands/after.mdx

@@ -4,7 +4,10 @@
 
 ### `after` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands-after}
 
-After is executed after the command was run. It is executed also when the command was interrupted which will set the env variable COMMAND_INTERRUPT to true as well as when the command errored which will set the error string to COMMAND_ERROR.
+After is executed after the command was run. It is executed also when
+the command was interrupted which will set the env variable COMMAND_INTERRUPT
+to true as well as when the command errored which will set the error string to
+COMMAND_ERROR.
 
 </summary>
 

docs/pages/configuration/_partials/v2beta1/commands/appendArgs.mdx

@@ -4,7 +4,8 @@
 
 ### `appendArgs` <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> {#commands-appendArgs}
 
-AppendArgs will append arguments passed to the DevSpace command automatically to the specified command.
+AppendArgs will append arguments passed to the DevSpace command automatically to
+the specified command.
 
 </summary>
 

docs/pages/configuration/_partials/v2beta1/commands/args.mdx

@@ -4,7 +4,8 @@
 
 ### `args` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands-args}
 
-Args are optional and if defined, command is not executed within a shell and rather directly.
+Args are optional and if defined, command is not executed within a shell
+and rather directly.
 
 </summary>
 

docs/pages/configuration/_partials/v2beta1/commands/command.mdx

@@ -4,7 +4,7 @@
 
 ### `command` <span className="config-field-required" data-required="true">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands-command}
 
-Command is the command that should be executed. For example: 'echo 123'.
+Command is the command that should be executed. For example: 'echo 123'
 
 </summary>
 

docs/pages/configuration/_partials/v2beta1/commands/description.mdx

@@ -4,7 +4,7 @@
 
 ### `description` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands-description}
 
-Description describes what the command is doing and can be seen in 'devspace list commands'.
+Description describes what the command is doing and can be seen in `devspace list commands`
 
 </summary>
 

docs/pages/configuration/_partials/v2beta1/commands/internal.mdx

@@ -4,7 +4,7 @@
 
 ### `internal` <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> {#commands-internal}
 
-Internal commands are not show in list and are usable through run_command.
+Internal commands are not show in list and are usable through run_command
 
 </summary>
 

docs/pages/configuration/_partials/v2beta1/commands/section.mdx

@@ -4,7 +4,7 @@
 
 ### `section` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands-section}
 
-Section can be used to group similar commands together in 'devspace list commands'.
+Section can be used to group similar commands together in `devspace list commands`
 
 </summary>
 

docs/pages/configuration/_partials/v2beta1/dependencies.mdx

@@ -7,7 +7,11 @@ import PartialDependenciesreference from "./dependencies_reference.mdx"
 
 ## `dependencies` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">&lt;dependency_name&gt;:object</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dependencies}
 
-Dependencies are sub devspace projects that lie in a local folder or remote git repository that can be executed from within the pipeline.
+Dependencies are sub devspace projects that lie in a local folder or remote git repository that can be executed
+from within the pipeline. In contrast to imports, these projects pose as separate fully functional DevSpace projects
+that typically lie including source code in a different folder and can be used to compose a full microservice
+application that will be deployed by DevSpace. Each dependency name can only be used once and if you want to use
+the same project multiple times, make sure to use a different name for each of those instances.
 
 </summary>
 
@@ -17,7 +21,7 @@ Dependencies are sub devspace projects that lie in a local folder or remote git
 
 ## `<dependency_name>` <span className="config-field-required" data-required="true">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dependencies-name}
 
-Name is used internally.
+Name is used internally
 
 </summary>