Skip to content

Rewrite "here" links in the docs #5984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Rewrite "here" links in the docs #5984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/contributors/testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ Please run the following style and formatting commands and fix/check-in any chan

3. Checking the documentation

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

4. Pre-submit Flight Checks

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

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

[testing-docs-locally]: docs.md#testing-docs-locally

## Opening A Pull Request

### Draft Mode
Expand Down
5 changes: 4 additions & 1 deletion docs/runtime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,10 @@ helm install nvidia-gpu-operator -n nvidia-gpu-operator \

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.

**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).
**Note**: Detailed installation instructions can be found in the [official
NVIDIA GPU Operator documentation][install-nvidia-gpu-operator].

[install-nvidia-gpu-operator]: https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/getting-started.html

## Using custom CRI runtimes

Expand Down
5 changes: 3 additions & 2 deletions docs/system-requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,9 @@ For information on the required ports and protocols, refer to [networking](netwo

## External runtime dependencies

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

To run some automated compatiblility checks on your system, use
[`k0s sysinfo`](cli/k0s_sysinfo.md).
Expand Down
5 changes: 3 additions & 2 deletions hack/ostests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,9 @@ export AWS_SESSION_TOKEN=...
export AWS_REGION=...
```

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

```shell
export TF_VAR_os=alpine_3_21
Expand Down