Skip to content

Commit 608340a

Browse files
authored
Merge pull request #6038 from killianmuldoon/docs/remove-self-links
📖 Docs/remove self links
2 parents fe7656c + d3602e9 commit 608340a

File tree

8 files changed

+12
-12
lines changed

8 files changed

+12
-12
lines changed

docs/book/src/developer/e2e.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ The [test E2E package] provides examples of how this can be achieved by implemen
199199
test specs for the most common Cluster API use cases.
200200

201201
<!-- links -->
202-
[Cluster API quick start]: https://cluster-api.sigs.k8s.io/user/quick-start.html
202+
[Cluster API quick start]: ../user/quick-start.md
203203
[Cluster API test framework]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework?tab=doc
204204
[deprecated E2E config file]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework?tab=doc#Config
205205
[deprecated InitManagementCluster method]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework?tab=doc#InitManagementCluster

docs/book/src/developer/guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The easiest way to do this is with [kind] v0.9 or newer, as explained in the qui
3333
Make sure your cluster is set as the default for `kubectl`.
3434
If it's not, you will need to modify subsequent `kubectl` commands below.
3535

36-
[mcluster]: https://cluster-api.sigs.k8s.io/reference/glossary.html#management-cluster
36+
[mcluster]: ../reference/glossary.md#management-cluster
3737
[kind]: https://github.com/kubernetes-sigs/kind
3838

3939
### A container registry
@@ -220,7 +220,7 @@ information on each suite.
220220
Now you can [create CAPI objects][qs]!
221221
To test another iteration, you'll need to follow the steps to build, push, update the manifests, and apply.
222222

223-
[qs]: https://cluster-api.sigs.k8s.io/user/quick-start.html#usage
223+
[qs]: ../user/quick-start.md#usage
224224

225225
## Videos explaining CAPI architecture and code walkthroughs
226226

docs/book/src/developer/providers/implementers-guide/generate_crds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ The cluster API CRDs should be further customized:
8787
- [Upgrade to CRD v1](https://release-0-4.cluster-api.sigs.k8s.io/developer/providers/v1alpha2-to-v1alpha3.html#upgrade-to-crd-v1)
8888
- [Set “matchPolicy=Equivalent” kubebuilder marker for webhooks](https://release-0-4.cluster-api.sigs.k8s.io/developer/providers/v1alpha2-to-v1alpha3.html#add-matchpolicyequivalent-kubebuilder-marker-in-webhooks)
8989
- [Refactor the kustomize config folder to support multi-tenancy](https://release-0-4.cluster-api.sigs.k8s.io/developer/providers/v1alpha2-to-v1alpha3.html#refactor-kustomize-config-folder-to-support-multi-tenancy-when-using-webhooks)
90-
- [Ensure you are compliant with the clusterctl provider contract](https://cluster-api.sigs.k8s.io/clusterctl/provider-contract.html#components-yaml)
90+
- [Ensure you are compliant with the clusterctl provider contract](../../../clusterctl/provider-contract.md#components-yaml)
9191
9292
### Commit your changes
9393

docs/book/src/developer/providers/implementers-guide/naming.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ Cluster API itself becomes [CAPI], pronounced "Cappy."
1818
cluster-api-provider-aws is [CAPA], pronounced "KappA."
1919
cluster-api-provider-gcp is [CAPG], pronounced "Cap Gee," [and so on][letterc].
2020

21-
[CAPI]: https://cluster-api.sigs.k8s.io/reference/glossary.html#capi
22-
[CAPA]: https://cluster-api.sigs.k8s.io/reference/glossary.html#capa
23-
[CAPG]: https://cluster-api.sigs.k8s.io/reference/glossary.html#capg
24-
[letterc]: https://cluster-api.sigs.k8s.io/reference/glossary.html#c
21+
[CAPI]: ../../../reference/glossary.md#capi
22+
[CAPA]: ../../../reference/glossary.md#capa
23+
[CAPG]: ../../../reference/glossary.md#capg
24+
[letterc]: ../../../reference/glossary.md#c
2525

2626
## Resource Naming
2727

docs/book/src/developer/providers/implementers-guide/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Much of the information here was adapted directly from it.
88
This is an _infrastructure_ provider - tasked with managing provider-specific resources for clusters and machines.
99
There are also [bootstrap providers][bootstrap], which turn machines into Kubernetes nodes.
1010

11-
[bootstrap]: https://cluster-api.sigs.k8s.io/reference/providers.html?highlight=bootstrap#bootstrap
11+
[bootstrap]: ../../../reference/providers.md#bootstrap
1212

1313
## Prerequisites
1414

docs/book/src/developer/providers/v1.0-to-v1.1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ are kept in sync with the versions used by `sigs.k8s.io/controller-runtime`.
5656

5757
* ClusterClass:
5858
* `clusterctl` is now able to handle cluster templates with ClusterClasses ([PR](https://github.com/kubernetes-sigs/cluster-api/pull/5351)).
59-
Please check out the corresponding documentation in [clusterctl provider contract](https://cluster-api.sigs.k8s.io/clusterctl/provider-contract.html#clusterclass-definitions).
59+
Please check out the corresponding documentation in [clusterctl provider contract](../../clusterctl/provider-contract.md#clusterclass-definitions)
6060
If you have any further questions about writing ClusterClasses, please let us know.
6161
* e2e tests:
6262
* `QuickStartSpec` is now able to test clusters using ClusterClass. Please see this [PR](https://github.com/kubernetes-sigs/cluster-api/pull/5423) for an example on how to use it.

docs/book/src/developer/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -417,7 +417,7 @@ In Cluster API all the test MUST use [Gomega] assertions.
417417

418418
In Cluster API Unit and integration test MUST use [go test].
419419

420-
[Cluster API quick start]: https://cluster-api.sigs.k8s.io/user/quick-start.html
420+
[Cluster API quick start]: ../user/quick-start.md
421421
[Cluster API test framework]: https://pkg.go.dev/sigs.k8s.io/cluster-api/test/framework?tab=doc
422422
[e2e development]: ./e2e.md
423423
[Ginkgo]: http://onsi.github.io/ginkgo/

docs/book/src/developer/tilt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ some of the clusterctl commands like clusterctl config won't work.
276276
277277
This limitation is an acceptable trade-off while executing fast dev-test iterations on controllers logic. If instead
278278
you are interested in testing clusterctl workflows, you should refer to the
279-
[clusterctl developer instructions](https://cluster-api.sigs.k8s.io/clusterctl/developers.html).
279+
[clusterctl developer instructions](../clusterctl/developers.md).
280280
281281
</aside>
282282

0 commit comments

Comments
 (0)