Skip to content

Commit d2e753e

Browse files
committed
Rewrite "here" links in the docs
Use descriptive link texts instead. Signed-off-by: Tom Wieczorek <[email protected]>
1 parent c7f6891 commit d2e753e

File tree

5 files changed

+17
-8
lines changed

5 files changed

+17
-8
lines changed

docs/contributors/testing.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ Please run the following style and formatting commands and fix/check-in any chan
2727

2828
3. Checking the documentation
2929

30-
Verify any changes to the documentation by following the instructions
31-
[here](docs.md#testing-docs-locally).
30+
Follow the [instructions for testing the documentation
31+
locally][testing-docs-locally] to verify any changes.
3232

3333
4. Pre-submit Flight Checks
3434

@@ -50,6 +50,8 @@ Please run the following style and formatting commands and fix/check-in any chan
5050

5151
If you find that all tests passed, you may open a pull request upstream.
5252

53+
[testing-docs-locally]: docs.md#testing-docs-locally
54+
5355
## Opening A Pull Request
5456

5557
### Draft Mode

docs/examples/ambassador-ingress.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
You can configure k0s with the [Ambassador API Gateway](https://www.getambassador.io/products/api-gateway/) and a [MetalLB service loadbalancer](https://metallb.universe.tf/). To do this you leverage Helm's extensible bootstrapping functionality to add the correct extensions to the `k0s.yaml` file during cluster configuration.
44

5-
Note: Currently Ambassador API Gateway does not support Kubernetes v1.22 or above. See [here](https://github.com/emissary-ingress/emissary/issues/3735#issuecomment-916278895) for details.
5+
Note: Currently Ambassador API Gateway does not support Kubernetes v1.22 or
6+
above. See [this comment on emissary-ingress/emissary#3735](https://github.com/emissary-ingress/emissary/issues/3735#issuecomment-916278895)
7+
for details.
68

79
## Use Docker for non-native k0s platforms
810

docs/runtime.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,10 @@ helm install nvidia-gpu-operator -n nvidia-gpu-operator \
219219
220220
With this Helm chart values, NVIDIA GPU operator will deploy both driver and toolkit to the GPU nodes and additionally will configure containerd with NVIDIA specific runtime.
221221
222-
**Note**: Detailed instruction on how to deploy NVIDIA GPU operator on your k0s cluster is available [here](https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/getting-started.html).
222+
**Note**: Detailed installation instructions can be found in the [official
223+
NVIDIA GPU Operator documentation][install-nvidia-gpu-operator].
224+
225+
[install-nvidia-gpu-operator]: https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/getting-started.html
223226
224227
## Using custom CRI runtimes
225228

docs/system-requirements.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,9 @@ For information on the required ports and protocols, refer to [networking](netwo
6262

6363
## External runtime dependencies
6464

65-
k0s strives to be as independent from the OS as possible. The current and past
66-
external runtime dependencies are documented [here](external-runtime-deps.md).
65+
k0s strives to be as independent from the operating system as possible. See the
66+
dedicated section on [external runtime dependencies](external-runtime-deps.md)
67+
for details on current and past requirements.
6768

6869
To run some automated compatiblility checks on your system, use
6970
[`k0s sysinfo`](cli/k0s_sysinfo.md).

hack/ostests/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@ export AWS_SESSION_TOKEN=...
4444
export AWS_REGION=...
4545
```
4646

47-
Select the desired cluster configuration for OpenTofu. Again, just an example,
48-
other ways described [here][tf-config].
47+
Select the desired cluster configuration for OpenTofu. This is just one example;
48+
other methods of passing configuration options are covered in the [official
49+
OpenTofu documentation][tf-config].
4950

5051
```shell
5152
export TF_VAR_os=alpine_3_21

0 commit comments

Comments
 (0)