Skip to content

Commit 8793a78

Browse files
committed
Fixing broken relative links
1 parent cba8f0e commit 8793a78

19 files changed

Lines changed: 110 additions & 393 deletions

File tree

docs/pages/configuration/dependencies/basics.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Dependencies for DevSpace projects are defined within the `dependencies` section
2525

2626
```yaml
2727
dependencies:
28-
- name: api-server
28+
- name: api-server
2929
source:
3030
git: https://github.com/my-api-server
3131
branch: stable
@@ -114,7 +114,7 @@ dependencies:
114114
source:
115115
path: dep1
116116
dev:
117-
# Will open a terminal to the pod with the
117+
# Will open a terminal to the pod with the
118118
# image from dep1
119119
terminal:
120120
imageSelector: ${runtime.dependencies.dep1.images.image1}
@@ -136,7 +136,7 @@ deployments:
136136

137137
### Referencing Dependencies in Deployment Values / Manifests
138138

139-
It is also possible to reference a dependency's image with [runtime variables](../variables/runtime-variables.mdx) in a deployment:
139+
It is also possible to reference a dependency's image with [runtime variables](../variables/built-in.mdx) in a deployment:
140140
```yaml
141141
dependencies:
142142
- name: dep1
@@ -148,7 +148,7 @@ deployments:
148148
componentChart: true
149149
values:
150150
containers:
151-
- image: ${runtime.dependencies.dep1.image1.image}:${runtime.dependencies.dep1.image1.tag} # -> replaced with 'myusername/devspace:xxxx'
151+
- image: ${runtime.dependencies.dep1.image1.image}:${runtime.dependencies.dep1.image1.tag} # -> replaced with 'myusername/devspace:xxxx'
152152
```
153153

154154
With a dependency `dep1/devspace.yaml` that looks like:

docs/pages/configuration/deployments/helm/basics.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ deployments:
4747
name: chart-name
4848
repo: https://my-charts.company.tld/
4949
values:
50-
# If registry.url/repo/image was found under images as well, will be
50+
# If registry.url/repo/image was found under images as well, will be
5151
# rewritten to registry.url/repo/image:generated_tag
5252
imageWithTag: registry.url/repo/image
5353
# If registry.url/repo/image was found under images.app as well, will be
@@ -135,7 +135,7 @@ deployments:
135135
```
136136

137137
### `updateImageTags`
138-
The `updateImageTags` option expects a boolean stating if DevSpace should do [Image Tag Replacement](../../configuration/deployments/basics.mdx#3-tag-replacement).
138+
The `updateImageTags` option expects a boolean stating if DevSpace should do [Image Tag Replacement](../basics.mdx#3-tag-replacement).
139139

140140
When set to `true`, DevSpace searches all your values (specified via `values` or `valuesFiles`) 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.
141141

@@ -201,7 +201,7 @@ deployments:
201201
chart:
202202
name: bitnami/mysql
203203
```
204-
**Explanation:**
204+
**Explanation:**
205205
Deploying the above example would roughly be equivalent to this command:
206206
```bash
207207
helm install database bitnami/mysql
@@ -228,7 +228,7 @@ deployments:
228228
name: bitnami/mysql
229229
version: "1.3.1"
230230
```
231-
**Explanation:**
231+
**Explanation:**
232232
Deploying the above example would roughly be equivalent to this command:
233233
```bash
234234
helm install database bitnami/mysql --version="1.3.1"
@@ -246,7 +246,7 @@ deployments:
246246
name: custom-chart
247247
repo: https://my-repo.tld/
248248
```
249-
**Explanation:**
249+
**Explanation:**
250250
Deploying the above example would roughly be equivalent to this command:
251251
```bash
252252
helm install database custom-chart --repo "https://my-repo.tld/"
@@ -266,7 +266,7 @@ The `values` option expects an object with values that should be overriding the
266266

267267
Compared to the `valuesFiles` option, using `values` has the following advantages:
268268
- It is easier to comprehend and faster to find (no references)
269-
- It allows you to use [dynamic config variables](../../configuration/variables/basics.mdx)
269+
- It allows you to use [dynamic config variables](../../variables/basics.mdx)
270270

271271
:::info
272272
Because both, `values` and `valuesFiles`, have advantages and disadvantages, it is often useful to combine them. When setting both, values defined in `values` have precedence over values defined in `valuesFiles`.
@@ -289,7 +289,7 @@ deployments:
289289
mysqlUser: db_user
290290
mysqlDatabase: app_database
291291
```
292-
**Explanation:**
292+
**Explanation:**
293293
Deploying the above example would roughly be equivalent to this command:
294294
```bash
295295
helm install database bitnami/mysql --set mysqlRootPassword="$MYSQL_ROOT_PASSWORD" --set mysqlUser="db_user" --set mysqlDatabase="app_database"
@@ -322,7 +322,7 @@ deployments:
322322
- mysql/values.yaml
323323
- mysql/values.production.yaml
324324
```
325-
**Explanation:**
325+
**Explanation:**
326326
Deploying the above example would roughly be equivalent to this command:
327327
```bash
328328
helm install database bitnami/mysql -f mysql/values.yaml -f mysql/values.production.yaml
@@ -349,7 +349,7 @@ deployments:
349349
name: bitnami/mysql
350350
```
351351

352-
**Explanation:**
352+
**Explanation:**
353353
Deploying the above example would print the helm output and the `notes.txt` from the bitnami/mysql chart.
354354

355355
### `templateArgs`

docs/pages/configuration/dev/basics.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Kubernetes-based development can be useful in the following cases:
1919
- You want to test your application in a production-like environment
2020
- You want to debug issues that are hard to reproduce on your local machine
2121

22-
The development experience is very similar to using `docker-compose`, so if you are already familiar on how to develop with `docker-compose`, DevSpace will behave very similar. One of the major benefits of DevSpace versus docker-compose is that DevSpace allows you to develop in any Kubernetes cluster, either locally using minikube, Docker Kubernetes etc. or in any remote Kubernetes cluster.
22+
The development experience is very similar to using `docker-compose`, so if you are already familiar on how to develop with `docker-compose`, DevSpace will behave very similar. One of the major benefits of DevSpace versus docker-compose is that DevSpace allows you to develop in any Kubernetes cluster, either locally using minikube, Docker Kubernetes etc. or in any remote Kubernetes cluster.
2323

2424

2525
## Start Development Mode
@@ -93,7 +93,7 @@ DevSpace provides two options to develop applications in Kubernetes:
9393
:::note Multi-Container Log Streaming (default)
9494
The first option starts your application as defined in your Dockerfile or in your Kubernetes pod definition. After the pods are started, DevSpace streams the logs of all containers that are started with an image that was built during the image building process. Each log line is prefixed with the image name or alternatively with the pod name of the container. Before starting the actual log streaming, DevSpace prints the last 50 log lines of each container by default.
9595

96-
Learn how to [customize which containers should be included in the log stream and how many log lines should be shown in the beginning](../../configuration/development/log-streaming.mdx).
96+
Learn how to [customize which containers should be included in the log stream and how many log lines should be shown in the beginning](../../configuration/dev/workflow/log-streaming.mdx).
9797
:::
9898

9999
:::note Terminal Session
@@ -103,15 +103,15 @@ devspace dev -t
103103
```
104104
Instead of starting the multi-container log streaming, you can also start development mode using a terminal session.
105105

106-
Terminal is configurable by [using the `dev.terminal` configuration section](../../configuration/development/terminal.mdx).
106+
Terminal is configurable by [using the `dev.terminal` configuration section](../../configuration/dev/workflow/terminal.mdx).
107107
:::
108108

109109
### 8. Open Links (optional)
110110
DevSpace iterates over every item in the `dev.open` array defined in the `devspace.yaml` and tries to open the URL you provide for each item using the following method:
111111

112112
<FragmentWorkflowOpenLinks/>
113113

114-
Learn more about [configuring auto-opening links](../../configuration/development/open-links.mdx).
114+
Learn more about [configuring auto-opening links](../../configuration/dev/workflow/open.mdx).
115115

116116

117117

0 commit comments

Comments
 (0)