Skip to content

Updated some doc links #185

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 2 commits into
base: main
Choose a base branch
from
Open

Updated some doc links #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1a4b52
Update README.md
enrichman Sep 16, 2025
82f42aa
updated doc links
enrichman Sep 16, 2025
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: 3 additions & 3 deletions docs/tilt-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ This document describes how to use kind and [Tilt][tilt] for a simplified workfl
Also, visit the [Cluster API documentation on Tilt][cluster_api_tilt] for more information on how to set up your development environment.

[tilt]: https://tilt.dev
[cluster_api_tilt]: https://cluster-api.sigs.k8s.io/developer/tilt.html
[cluster_api_tilt]: https://cluster-api.sigs.k8s.io/developer/core/tilt
[capd]: https://github.com/kubernetes-sigs/cluster-api/tree/main/test/infrastructure/docker

## Getting started

1. You need to follow the [Prerequisites in Cluster API documentation on Tilt](https://cluster-api.sigs.k8s.io/developer/tilt.html#prerequisites) to have everything installed.
1. You need to follow the [Prerequisites in Cluster API documentation on Tilt](https://cluster-api.sigs.k8s.io/developer/core/tilt#prerequisites) to have everything installed.

2. Get the source for cluster-api repo

Expand All @@ -33,7 +33,7 @@ Also, visit the [Cluster API documentation on Tilt][cluster_api_tilt] for more i

4. Create the `tilt-settings.yaml` file and place it in your local copy of `cluster-api`. Here is an example:
```yaml
# refer to https://cluster-api.sigs.k8s.io/developer/tilt.html for documentation
# refer to https://cluster-api.sigs.k8s.io/developer/core/tilt for documentation
allowed_contexts:
- kind-capi-test
trigger_mode: manual # set to auto to enable auto-rebuilding
Expand Down
4 changes: 2 additions & 2 deletions test/e2e/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# e2e test
The e2e test use the [Cluster API test framework](https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework?tab=doc) and use the [CAPD](https://github.com/kubernetes-sigs/cluster-api/tree/main/test/infrastructure/docker) as the infrastructure provider. Please make sure you have [Docker](https://docs.docker.com/install/) and [kind](https://kind.sigs.k8s.io/) installed.

You could refer to the [Testing Cluster API](https://cluster-api.sigs.k8s.io/developer/testing) for more information.
You could refer to the [Testing Cluster API](https://cluster-api.sigs.k8s.io/developer/core/testing) for more information.

## Run the e2e test
The e2e image will be built with tag `dev`. You should build the image first before running the test.
Expand All @@ -15,7 +15,7 @@ To run a specific e2e test, such as `[PR-Blocking]`, use the `GINKGO_FOCUS` envi
make GINKGO_FOCUS="\\[PR-Blocking\\]" test-e2e # only run e2e test with `[PR-Blocking]` in its spec name
```
## Develop an e2e test
You could refer to [Developing E2E tests](https://cluster-api.sigs.k8s.io/developer/e2e) for a complete guide for developing e2e tests.
You could refer to [Developing E2E tests](https://cluster-api.sigs.k8s.io/developer/core/e2e) for a complete guide for developing e2e tests.

A guide for developing a k3s e2e test:

Expand Down