Skip to content

Commit 89d0cb2

Browse files
🔪 broken link stragglers (#627)
* 🔪 broken link stragglers This should be a build error * turn on strict mode * always build
1 parent 5020065 commit 89d0cb2

File tree

6 files changed

+15
-21
lines changed

6 files changed

+15
-21
lines changed

‎.github/workflows/main.yml

+2-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
name: Build and publish doc
2-
3-
on:
4-
push:
5-
branches:
6-
- main
7-
2+
on: push
83
jobs:
94
build:
105
runs-on: ubuntu-latest
@@ -42,6 +37,7 @@ jobs:
4237
./build.sh nav ssb ci-nais dev-nais tenant
4338
4439
publish:
40+
if: github.ref == 'refs/heads/master'
4541
needs: build
4642
runs-on: ubuntu-latest
4743
strategy:

‎build.sh

+3-4
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,10 @@ mkdir -p ./out ./docs-base
66
# Copy documentation to base folder as we need to use docs as a staging folder
77
cp -r ./docs/* ./docs-base
88

9-
for TENANT in $@;
10-
do
9+
for TENANT in $@;
10+
do
1111
rm -rf ./docs
1212
cp -r ./docs-base ./docs
1313
cp -rf ./tenants/$TENANT/* ./docs
14-
TENANT=$TENANT poetry run mkdocs build --no-strict -d out/$TENANT
14+
TENANT=$TENANT poetry run mkdocs build --strict -d out/$TENANT
1515
done
16-

‎docs/how-to-guides/naisdevice/install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191

9292
### Connect naisdevice through task/sys -tray icon
9393

94-
![A macOS systray exemplifying a red-colored `naisdevice` icon.](../assets/naisdevice-systray-icon.svg)
94+
![A macOS systray exemplifying a red-colored `naisdevice` icon.](../../assets/naisdevice-systray-icon.svg)
9595

9696
When you have opened naisdevice, you may be concerned that nothing happened. The little naisdevice icon has appeared in your Systray (where all your small program icons are located - see above picture for how it looks on Mac):
9797

‎docs/how-to-guides/observability/logs/kubectl.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This guide will show you how to view logs from the command line using `kubectl`.
88

99
## 0. Prerequisites
1010

11-
- You have installed the [kubectl](../../command-line-access.md) command-line tool.
11+
- You have installed the [kubectl](../../command-line-access/setup.md) command-line tool.
1212
- You have access to the [team](../../team.md) where the application is running.
1313

1414
## 1. Find the pod name

‎docs/how-to-guides/observability/tracing/correlate-traces-logs.md

-2
Original file line numberDiff line numberDiff line change
@@ -84,5 +84,3 @@ The final step is to include trace information in your logs. This will allow Gra
8484
Now that you have tracing and logging set up, you can use Grafana Tempo to correlate traces and logs. When you view a trace in Grafana Tempo, you can see the logs that are associated with that trace. This makes it easy to understand what happened in your application and troubleshoot issues.
8585

8686
![Correlate traces and logs](../../../assets/grafana-tempo-logs.png)
87-
88-
[:arrow_backward: Back to the list of guides](../index.md)

‎docs/how-to-guides/persistence/redis/README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ Operator.
66
You can create many Redis instances for your `Application`.
77

88
## 0. Prerequisites
9-
- [Member of a NAIS team](../../explanation/team.md)
9+
- [Member of a NAIS team](../../../explanation/team.md)
1010

1111
!!! warning It is not possible to share Redis instances between teams.
1212

13-
## 1. Enable Redis in your [manifest](../../reference/application-spec.md)
13+
## 1. Enable Redis in your [manifest](../../../reference/application-spec.md)
1414

1515
???+ note ".nais/app.yaml"
1616
```yaml
@@ -27,7 +27,7 @@ The above snippet will allow your application to use the `sessions`
2727
Redis instance, and provide the application with credentials for a
2828
read/write user. In addition, the application will get credentials for
2929
a read-only user for the `lookup` instance. See the [manifest
30-
reference](../../reference/application-spec.md#redis) for other
30+
reference](../../../reference/application-spec.md#redis) for other
3131
options for `access`.
3232

3333
If all you need is a Redis instance for one application using just the
@@ -39,8 +39,9 @@ redis instances](./create-redis-instance-explicitly.md).
3939
For each edis instance, your application will receive
4040
three environment variables. The environment variables use a fixed
4141
prefix, and the instance name uppercased as a suffix.
42-
| Key | Value | |
43-
|----------------------------------|--------------------------------------|---|
44-
| `REDIS_URI_<InstanceName>` | The URI for the instance | |
45-
| `REDIS_USERNAME_<InstanceName>` | The username to use when connecting. | |
42+
43+
| Key | Value | |
44+
|---------------------------------|--------------------------------------|---|
45+
| `REDIS_URI_<InstanceName>` | The URI for the instance | |
46+
| `REDIS_USERNAME_<InstanceName>` | The username to use when connecting. | |
4647
| `REDIS_PASSWORD_<InstanceName>` | The password to use when connecting. | |

0 commit comments

Comments
 (0)