Skip to content

Commit 918f5e1

Browse files
authored
Merge pull request #2860 from mjlshen/docs
📖 fix broken hyperlinks in kustomize/v2-alpha docs
2 parents 20828c7 + c1dd668 commit 918f5e1

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

docs/book/src/plugins/kustomize-v2-alpha.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Kustomize v2-alpha
1+
# Kustomize v2-alpha
22

33
The kustomize plugin allows you to scaffold all kustomize manifests used to work with the language base plugin `base.go.kubebuilder.io/v3`.
44

@@ -15,7 +15,7 @@ able to create "helper" plugins which can work with many projects and languages.
1515
You can check the kustomize content by looking at the `config/` directory provide on the sample `project-v3-with-kustomize-v2` under the [testdata][testdata]
1616
directory of the Kubebuilder project.
1717

18-
</aside>
18+
</aside>
1919

2020
## When to use it
2121

@@ -24,15 +24,15 @@ directory of the Kubebuilder project.
2424
- If you are looking for to begin to try out the new syntax and features provide by kustomize v4
2525
- If you are NOT looking to build projects which will be used on Kubernetes cluster versions < `1.22` (_The new features provides by kustomize v4 are not officially supported and might not work with kubectl < `1.22`_)
2626
- If you are NOT looking to rely on special URLs in resource fields
27-
- If you want to use [replacements][https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/replacements/] since [vars][https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/vars/] are deprecated and might be removed soon
27+
- If you want to use [replacements][kustomize-replacements] since [vars][kustomize-vars] are deprecated and might be removed soon
2828

2929
<aside class="note">
3030
<h1>Supportability</h1>
3131

3232
You can use `kustomize/v1` plugin which is the default configuration adopted by the `go/v3` plugin if you are not prepared to began to experiment kustomize `v4`.
33-
Also, be aware that the `base.go.kubebuilder.io/v3` is prepared to work with this plugin.
33+
Also, be aware that the `base.go.kubebuilder.io/v3` is prepared to work with this plugin.
3434

35-
</aside>
35+
</aside>
3636

3737

3838
## How to use it
@@ -61,8 +61,8 @@ import (
6161
Also, with Kubebuilder, you can use kustomize/v2-alpha alone via:
6262

6363
```sh
64-
kubebuilder init --plugins=kustomize/v2-alpha
65-
$ ls -la
64+
kubebuilder init --plugins=kustomize/v2-alpha
65+
$ ls -la
6666
total 24
6767
drwxr-xr-x 6 camilamacedo86 staff 192 31 Mar 09:56 .
6868
drwxr-xr-x 11 camilamacedo86 staff 352 29 Mar 21:23 ..
@@ -75,8 +75,8 @@ drwx------ 6 camilamacedo86 staff 192 31 Mar 09:56 config
7575
Or combined with the base language plugins:
7676

7777
```sh
78-
# Provides the same scaffold of go/v3 plugin which is composition but with kustomize/v2-alpha
79-
kubebuilder init --plugins=kustomize/v2-alpha,base.go.kubebuilder.io/v3 --domain example.org --repo example.org/guestbook-operator
78+
# Provides the same scaffold of go/v3 plugin which is composition but with kustomize/v2-alpha
79+
kubebuilder init --plugins=kustomize/v2-alpha,base.go.kubebuilder.io/v3 --domain example.org --repo example.org/guestbook-operator
8080
```
8181

8282
## Subcommands
@@ -94,7 +94,7 @@ Its implementation for the subcommand create api will scaffold the kustomize man
9494
which are specific for each API, see [here][kustomize-create-api]. The same applies
9595
to its implementation for create webhook.
9696

97-
</aside>
97+
</aside>
9898

9999
## Affected files
100100

@@ -116,4 +116,6 @@ The following scaffolds will be created or updated by this plugin:
116116
[kustomize-create-api]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/pkg/plugins/common/kustomize/v2/scaffolds/api.go#L72-L84
117117
[kustomize-docs]: https://kustomize.io/
118118
[kustomize-github]: https://github.com/kubernetes-sigs/kustomize
119-
[release-notes]: https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize%2Fv4.0.0
119+
[kustomize-replacements]: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/replacements/
120+
[kustomize-vars]: https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/vars/
121+
[release-notes]: https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize%2Fv4.0.0

0 commit comments

Comments
 (0)