Skip to content

Commit 26ac246

Browse files
committed
docs: fix examples
1 parent 26753ab commit 26ac246

5 files changed

Lines changed: 35 additions & 48 deletions

File tree

docs/pages/configuration/commands/README.mdx

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,10 @@ Custom commands are being shared in the `commands` section of `devspace.yaml`:
1313
images:
1414
default:
1515
image: john/backend
16+
1617
commands:
17-
- name: debug-backend
18-
command: "devspace dev --profile=debug-backend $@"
19-
profiles:
20-
- name: debug-backend
21-
patches:
22-
- op: replace
23-
path: images.default.entrypoint
24-
value: ["npm", "run", "debug"]
18+
debug-backend: |-
19+
devspace dev $@
2520
```
2621
2722
:::note
@@ -31,15 +26,13 @@ Custom commands can be used for more than just running `devspace` commands, e.g.
3126
The above example configuration would allow everyone to run the custom command `debug-backend` like this:
3227
```bash
3328
devspace run debug-backend
34-
devspace run debug-backend --verbose-dependencies
35-
devspace run debug-backend -- --verbose-dependencies -s
29+
devspace run debug-backend -n my-namespace
3630
```
3731

3832
And `devspace run` would execute the following commands internally:
3933
```bash
40-
devspace dev --profile=debug-backend
41-
devspace dev --profile=debug-backend --verbose-dependencies
42-
devspace dev --profile=debug-backend --verbose-dependencies -s
34+
devspace dev
35+
devspace dev -n my-namespace
4336
```
4437

4538
:::note `--` End of Options Separator

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

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,21 @@ import ConfigPartialDependencyExecution from '../_partials/v2beta1/dependencies/
99

1010
```yaml
1111
dependencies:
12-
- name: api-server
13-
source:
12+
api-server:
1413
git: https://github.com/my-api-server
1514
branch: stable
16-
dev:
17-
sync: true
18-
- name: auth-server
19-
source:
15+
auth-server:
2016
git: https://github.com/my-auth-server
2117
revision: c967392
22-
profile: production
23-
- name: database-server
24-
source:
18+
pipeline: dev
19+
database-server:
2520
git: https://github.com/my-database-server
2621
tag: v3.0.1
2722
subPath: /configuration
28-
dev:
29-
ports: true
3023
dev:
31-
terminal:
24+
my-dev:
3225
imageSelector: ghcr.io/org/project/image
26+
terminal: {}
3327
```
3428
3529
:::info Authentication

docs/pages/configuration/dependencies/local-folder.mdx

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,17 @@ import ConfigPartialDependencyExecution from '../_partials/v2beta1/dependencies/
99

1010
```yaml
1111
dependencies:
12-
- name: component-1
13-
source:
12+
component-1:
13+
# Expects a devspace.yaml at ./different/component-1/devspace.yaml
1414
path: ./different/component-1
15-
path: ./different/component-1
16-
- name: component-2
17-
source:
18-
path: ./different/component-2
19-
path: ./different/component-2
15+
component-2:
16+
# Direct path to other-devspace.yaml
17+
path: ./different/component-1/other-devspace.yaml
2018
deployments:
21-
- name: use-dependency-image
22-
- name: use-dependency-image
23-
helm:
24-
componentChart: true
25-
values:
26-
containers:
27-
- image: ghcr.io/org/project/image
19+
use-dependency-image:
20+
helm:
21+
values:
22+
containers:
2823
- image: ghcr.io/org/project/image
2924
```
3025

docs/pages/configuration/dev/connections/restart-helper.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ To tell DevSpace to inject the restart helper into the container, set `inject: t
2222
dev:
2323
app:
2424
imageSelector: ghcr.io/org/project/image
25+
command: ["restart", "this", "command"]
26+
args: ["with", "these", "args"]
2527
restartHelper:
2628
inject: true
2729
```

docs/pages/configuration/pullSecrets/README.mdx

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,10 @@ Image Pull Secrets are defined in the `pullSecrets` section of the `devspace.yam
2727
# If you don't want to specify the password and username directly in the config
2828
# you can use variables, .env file or save the credentials in the local docker store
2929
pullSecrets:
30-
- registry: my-registry.com:5000
31-
username: ${REGISTRY_USER}
32-
password: ${REGISTRY_PASSWORD}
30+
my-pullsecret:
31+
registry: my-registry.com:5000
32+
username: ${REGISTRY_USER}
33+
password: ${REGISTRY_PASSWORD}
3334
```
3435
3536
</TabItem>
@@ -40,19 +41,21 @@ pullSecrets:
4041
# to get these from the local docker store. Make sure you
4142
# are logged into the registry with `docker login my-registry.com:5000`
4243
pullSecrets:
43-
- registry: my-registry.com:5000
44+
my-pullsecret:
45+
registry: my-registry.com:5000
4446
```
4547
4648
</TabItem>
4749
<TabItem value="custom">
4850
4951
```yaml
5052
pullSecrets:
51-
- registry: my-registry.com:5000
52-
secret: my-pull-secret-name
53-
serviceAccounts:
54-
- default
55-
- my-other-service-account
53+
my-pullsecret:
54+
registry: my-registry.com:5000
55+
secret: my-pull-secret-name
56+
serviceAccounts:
57+
- default
58+
- my-other-service-account
5659
```
5760
5861
</TabItem>

0 commit comments

Comments
 (0)