Skip to content

Commit 99fc3e6

Browse files
committed
docs: create v5.18 docs
1 parent 92f2e8b commit 99fc3e6

File tree

283 files changed

+4432
-3689
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

283 files changed

+4432
-3689
lines changed

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,5 @@ go run -mod=vendor ./hack/gen-docs.go
4545

4646
### 2. Create Version
4747
```bash
48-
yarn run docusaurus docs:version 5.17
48+
yarn run docusaurus docs:version 5.18
4949
```

docs/pages/commands/devspace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ DevSpace accelerates developing, deploying and debugging applications with Docke
3030
--restore-vars If true will restore the variables from kubernetes before loading the config
3131
--save-vars If true will save the variables to kubernetes after loading the config
3232
--silent Run in silent mode and prevents any devspace log output except panics & fatals
33-
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
33+
-s, --switch-context DEPRECATED: Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
3434
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
3535
--vars-secret string The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars")
3636
```

docs/pages/commands/devspace_add.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Adds config sections to devspace.yaml
4040
--restore-vars If true will restore the variables from kubernetes before loading the config
4141
--save-vars If true will save the variables to kubernetes after loading the config
4242
--silent Run in silent mode and prevents any devspace log output except panics & fatals
43-
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
43+
-s, --switch-context DEPRECATED: Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
4444
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
4545
--vars-secret string The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars")
4646
```

docs/pages/commands/devspace_add_plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ devspace add plugin https://github.com/my-plugin/plugin
4848
--restore-vars If true will restore the variables from kubernetes before loading the config
4949
--save-vars If true will save the variables to kubernetes after loading the config
5050
--silent Run in silent mode and prevents any devspace log output except panics & fatals
51-
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
51+
-s, --switch-context DEPRECATED: Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
5252
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
5353
--vars-secret string The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars")
5454
```

docs/pages/commands/devspace_analyze.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ devspace analyze --namespace=mynamespace
5454
--restore-vars If true will restore the variables from kubernetes before loading the config
5555
--save-vars If true will save the variables to kubernetes after loading the config
5656
--silent Run in silent mode and prevents any devspace log output except panics & fatals
57-
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
57+
-s, --switch-context DEPRECATED: Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
5858
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
5959
--vars-secret string The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars")
6060
```

docs/pages/commands/devspace_attach.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ devspace attach -n my-namespace
3333
-c, --container string Container name within pod where to execute command
3434
-h, --help help for attach
3535
--image string Image is the config name of an image to select in the devspace config (e.g. 'default'), it is NOT a docker image like myuser/myimage
36-
--image-selector string The image to search a pod for (e.g. nginx, nginx:latest, image(app), nginx:tag(app))
36+
--image-selector string The image to search a pod for (e.g. nginx, nginx:latest, ${runtime.images.app}, nginx:${runtime.images.app.tag})
3737
-l, --label-selector string Comma separated key=value selector list (e.g. release=test)
3838
--pick Select a pod (default true)
3939
--pod string Pod to open a shell to
@@ -56,7 +56,7 @@ devspace attach -n my-namespace
5656
--restore-vars If true will restore the variables from kubernetes before loading the config
5757
--save-vars If true will save the variables to kubernetes after loading the config
5858
--silent Run in silent mode and prevents any devspace log output except panics & fatals
59-
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
59+
-s, --switch-context DEPRECATED: Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
6060
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
6161
--vars-secret string The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars")
6262
```

docs/pages/commands/devspace_build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Builds all defined images and pushes them
5555
--restore-vars If true will restore the variables from kubernetes before loading the config
5656
--save-vars If true will save the variables to kubernetes after loading the config
5757
--silent Run in silent mode and prevents any devspace log output except panics & fatals
58-
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
58+
-s, --switch-context DEPRECATED: Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
5959
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
6060
--vars-secret string The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars")
6161
```

docs/pages/commands/devspace_cleanup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Cleans up resources
3939
--restore-vars If true will restore the variables from kubernetes before loading the config
4040
--save-vars If true will save the variables to kubernetes after loading the config
4141
--silent Run in silent mode and prevents any devspace log output except panics & fatals
42-
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
42+
-s, --switch-context DEPRECATED: Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
4343
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
4444
--vars-secret string The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars")
4545
```

docs/pages/commands/devspace_cleanup_images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Deletes all locally created docker images from docker
4545
--restore-vars If true will restore the variables from kubernetes before loading the config
4646
--save-vars If true will save the variables to kubernetes after loading the config
4747
--silent Run in silent mode and prevents any devspace log output except panics & fatals
48-
-s, --switch-context Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
48+
-s, --switch-context DEPRECATED: Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
4949
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
5050
--vars-secret string The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars")
5151
```
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: "Command - devspace completion"
3+
sidebar_label: devspace completion
4+
---
5+
6+
7+
Output shell completion for the given shell (bash or zsh)
8+
9+
## Synopsis
10+
11+
12+
```
13+
devspace completion SHELL [flags]
14+
```
15+
16+
```
17+
Outputs shell completion for the given shell (bash or zsh)
18+
19+
This depends on the bash-completion binary. Example installation instructions:
20+
OS X:
21+
$ brew install bash-completion
22+
$ source $(brew --prefix)/etc/bash_completion
23+
$ devspace completion bash > ~/.devspace-completion # for bash users
24+
$ devspace completion zsh > ~/.devspace-completion # for zsh users
25+
$ source ~/.devspace-completion
26+
Ubuntu:
27+
$ apt-get install bash-completion
28+
$ source /etc/bash-completion
29+
$ source <(devspace completion bash) # for bash users
30+
$ source <(devspace completion zsh) # for zsh users
31+
32+
Additionally, you may want to output the completion to a file and source in your .bashrc
33+
```
34+
35+
36+
## Flags
37+
38+
```
39+
-h, --help help for completion
40+
```
41+
42+
43+
## Global & Inherited Flags
44+
45+
```
46+
--config string The devspace config file to use
47+
--debug Prints the stack trace if an error occurs
48+
--disable-profile-activation If true will ignore all profile activations
49+
--inactivity-timeout int Minutes the current user is inactive (no mouse or keyboard interaction) until DevSpace will exit automatically. 0 to disable. Only supported on windows and mac operating systems (default 180)
50+
--kube-context string The kubernetes context to use
51+
-n, --namespace string The kubernetes namespace to use
52+
--no-warn If true does not show any warning when deploying into a different namespace or kube-context than before
53+
-p, --profile strings The DevSpace profiles to apply. Multiple profiles are applied in the order they are specified
54+
--profile-parent strings One or more profiles that should be applied before the specified profile (e.g. devspace dev --profile-parent=base1 --profile-parent=base2 --profile=my-profile)
55+
--profile-refresh If true will pull and re-download profile parent sources
56+
--restore-vars If true will restore the variables from kubernetes before loading the config
57+
--save-vars If true will save the variables to kubernetes after loading the config
58+
--silent Run in silent mode and prevents any devspace log output except panics & fatals
59+
-s, --switch-context DEPRECATED: Switches and uses the last kube context and namespace that was used to deploy the DevSpace project
60+
--var strings Variables to override during execution (e.g. --var=MYVAR=MYVALUE)
61+
--vars-secret string The secret to restore/save the variables from/to, if --restore-vars or --save-vars is enabled (default "devspace-vars")
62+
```
63+

0 commit comments

Comments
 (0)