Skip to content
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

📖 Fix broken CAPI related links #2159

Merged
merged 1 commit into from
Dec 16, 2024
Merged

📖 Fix broken CAPI related links #2159

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
4 changes: 2 additions & 2 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,14 +274,14 @@ The fields are:
would not be managed by the Metal3DataTemplate controller, if provided by the
user for example, the ownerreference should be set properly to ensure that the
secret belongs to the cluster ownerReference tree (see
[doc](https://cluster-api.sigs.k8s.io/clusterctl/provider-contract.html#ownerreferences-chain)).
[doc](https://cluster-api.sigs.k8s.io/developer/providers/contracts/clusterctl.html#ownerreferences-chain)).

- **networkData** is a reference to a secret containing the network data
rendered from the Metal3DataTemplate metadata template object automatically.
In case this would not be managed by the Metal3DataTemplate controller, if
provided by the user for example, the ownerreference should be set properly to
ensure that the secret belongs to the cluster ownerReference tree (see
[doc](https://cluster-api.sigs.k8s.io/clusterctl/provider-contract.html#ownerreferences-chain)).
[doc](https://cluster-api.sigs.k8s.io/developer/providers/contracts/clusterctl.html#ownerreferences-chain)).
The content of the secret should be a yaml equivalent of a json object that
follows the format definition that can be found
[here](https://docs.openstack.org/nova/latest/_downloads/9119ca7ac90aa2990e762c08baea3a36/network_data.json).
Expand Down
4 changes: 2 additions & 2 deletions docs/dev-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ following the
By default, the Cluster API components deployed by Tilt have experimental
features turned off. If you would like to enable these features, add
`extra_args` as specified in
[The Cluster API Book](https://cluster-api.sigs.k8s.io/developer/tilt.html#create-a-tilt-settingsjson-file).
[The Cluster API Book](https://cluster-api.sigs.k8s.io/developer/core/tilt#tilt-settings-fields).

Once your kind management cluster is up and running, you can
[deploy an example cluster](#deploy-an-example-cluster).
Expand All @@ -102,7 +102,7 @@ command
```

To use [Tilt](https://tilt.dev/) for a simplified development workflow, follow
the [instructions](https://cluster-api.sigs.k8s.io/developer/tilt.html) in the
the [instructions](https://cluster-api.sigs.k8s.io/developer/core/tilt.html) in the
cluster API repo. The instructions will walk you through cloning the Cluster API
(CAPI) repository and configuring Tilt to use `kind` to deploy the cluster api
management components.
Expand Down
2 changes: 1 addition & 1 deletion docs/e2e-test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This doc gives short instructions how to run e2e tests. For the developing e2e
tests, please refer to
[Developing E2E tests](https://cluster-api.sigs.k8s.io/developer/e2e.html).
[Developing E2E tests](https://cluster-api.sigs.k8s.io/developer/core/e2e).

## Prerequisites

Expand Down
Loading