Skip to content

Commit 4004723

Browse files
committed
docs: add v6 structure and content
1 parent b63768c commit 4004723

157 files changed

Lines changed: 2688 additions & 3333 deletions

File tree

Some content is hidden

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

cmd/init.go

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -443,15 +443,14 @@ echo 'Anyone using this project can invoke it via "devspace run migrate-db"'`,
443443

444444
// Add pipeline: dev
445445
config.Pipelines["dev"] = &latest.Pipeline{
446-
Run: `
447-
run_dependencies --all # 1. Deploy any projects this project needs (see "dependencies")
448-
create_deployments --all # 2. Deploy Helm charts and manifests specfied as "deployments"
449-
start_dev ` + imageName + ` # 3. Start dev mode "` + imageName + `" (see "dev" section)`,
446+
Run: `run_dependencies --all # 1. Deploy any projects this project needs (see "dependencies")
447+
create_deployments --all # 2. Deploy Helm charts and manifests specfied as "deployments"
448+
start_dev ` + imageName + ` # 3. Start dev mode "` + imageName + `" (see "dev" section)`,
450449
}
451450

452451
// Add pipeline: dev
453452
config.Pipelines["deploy"] = &latest.Pipeline{
454-
Run: `run_dependencies --all # 1. Deploy any projects this project needs (see "dependencies")
453+
Run: `run_dependencies --all # 1. Deploy any projects this project needs (see "dependencies")
455454
build_images --all -t $(git describe --always) # 2. Build, tag (git commit hash) and push all images (see "images")
456455
create_deployments --all # 3. Deploy Helm charts and manifests specfied as "deployments"`,
457456
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
:::info Component Chart Docs
2-
The component chart is a flexible Helm chart for deploying custom applications in a standardized manner. Learn more in the **[Component Chart Documentation](https://devspace.sh/component-chart/docs/introduction)**.
2+
The component chart is a flexible Helm chart for deploying custom applications in a standardized manner. Learn more about **[configuring component-chart deployments](../configuration/deployments/helm/chart/component-chart.mdx)**.
33
:::

docs/pages/_partials/kubectl-options-applyArgs.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,6 @@ The `applyArgs` option expects an array of strings stating additional arguments
44
Even if you set `kustomize: true`, DevSpace only renders the manifest templates using kustomize but the actual deployment will be executed using `kubectl apply`.
55
:::
66

7-
#### Default Value for `applyArgs`
8-
```yaml
9-
applyArgs: []
10-
```
11-
127
#### Example: Custom Kubectl Args & Flags
138
```yaml
149
deployments:
@@ -22,7 +17,6 @@ deployments:
2217
- "--grace-period"
2318
- "30"
2419
```
25-
**Explanation:**
2620
Deploying the above example would roughly be equivalent to this command:
2721
```bash
2822
kubectl apply --timeout=10s --grace-period=30 -f backend/
Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,8 @@
1-
The `updateImageTags` option expects a boolean stating if DevSpace should replace/update all image tags before deploying the project.
1+
If the `updateImageTags` field is set to `true` for a deployment, DevSpace will replace/update all image tags before deploying the project.
22

33
When enabled, DevSpace searches all your manifests 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.
44

5-
:::info In-Memory Tag Replacement
6-
Tag replacement takes place **in-memory** and is **not** writing anything to the filesystem, i.e. it will **never** change any of your configuration files.
7-
:::
8-
9-
#### Default Value for `updateImageTags`
10-
```yaml
11-
updateImageTags: false
12-
```
13-
14-
#### Example: Enable Tag Replacement
5+
#### Example: Enable Tag Updates
156
```yaml {3}
167
deployments:
178
backend:
@@ -20,3 +11,7 @@ deployments:
2011
manifests:
2112
- backend/
2213
```
14+
15+
:::info In-Memory Tag Replacement
16+
Tag replacement takes place **in-memory** and is **not** writing anything to the filesystem, i.e. it will **never** change any of your configuration files.
17+
:::

docs/pages/_partials/kustomize-options-binaryPath.mdx

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/pages/_partials/kustomize-options-kustomizeArgs.mdx

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
11
The `kustomizeArgs` option expects an array of strings stating additional arguments (and flags) that should be used when calling `kustomize build`.
22

3-
:::info Kustomize Deployments
4-
DevSpace only uses `kustomize build` to render the manifest templates. The actual deployment will be executed using `kubectl apply`.
5-
:::
6-
7-
#### Default Value for `kustomizeArgs`
8-
```yaml
9-
kustomizeArgs: []
10-
```
11-
123
#### Example: Custom Kustomize Args & Flags
134
```yaml
145
deployments:
@@ -23,7 +14,6 @@ deployments:
2314
- "--grace-period"
2415
- "30"
2516
```
26-
**Explanation:**
2717
Deploying the above example would roughly be equivalent to this command:
2818
```bash
2919
kustomize build --timeout=10s --grace-period=30 -f backend/
Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
11
:::warning
2-
It is highly discouraged to run `devspace dev` multiple times in parallel because multiple instances of port forwarding and file synchronization will disturb each other. Instead:
3-
4-
- Run `devspace enter` to open additional terminal sessions without port forwarding and file sync
5-
- Run `devspace logs` to start log streaming without port forwarding and file sync
6-
- Run `devspace sync` to sync files on-demand without starting port forwarding etc.
7-
- Run `devspace ui` to open the localhost development UI in the browser
2+
Running `devspace dev` multiple times in parallel for the <u>same project</u> does not work and returns a fatal error because multiple instances of port forwarding and file sync will disturb each other. However, running `devspace dev` for several different projects (i.e. 2 different `devspace.yaml` files with different `name`) works seamlessly.
83
:::
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
<details className="config-field" data-expandable="false" open>
3+
<summary>
4+
5+
### `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}
6+
7+
Section can be used to group similar commands together in `devspace list commands`
8+
9+
</summary>
10+
11+
12+
13+
</details>

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11

2+
import PartialSection from "./commands/section.mdx"
23
import PartialCommand from "./commands/command.mdx"
34
import PartialArgs from "./commands/args.mdx"
45
import PartialAppendArgs from "./commands/appendArgs.mdx"
56
import PartialDescription from "./commands/description.mdx"
67
import PartialInternal from "./commands/internal.mdx"
78
import PartialAfter from "./commands/after.mdx"
89

10+
<PartialSection />
11+
12+
913
<PartialCommand />
1014

1115

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
import PartialName from "./name.mdx"
3+
import PartialVersion from "./version.mdx"
4+
import PartialRepo from "./repo.mdx"
5+
import PartialUsername from "./username.mdx"
6+
import PartialPassword from "./password.mdx"
7+
8+
<div className="group" data-group="repo">
9+
<div className="group-name">Source: Helm Repository</div>
10+
11+
<PartialName />
12+
<PartialVersion />
13+
<PartialRepo />
14+
<PartialUsername />
15+
<PartialPassword />
16+
17+
</div>

0 commit comments

Comments
 (0)