Skip to content

Commit 148d879

Browse files
authored
Merge pull request #4599 from mo3et/master
📖 fix incorrect reference to "deploy-image-plugin" in docs.
2 parents d9c51f7 + f8b5a12 commit 148d879

File tree

3 files changed

+24
-25
lines changed

3 files changed

+24
-25
lines changed

docs/book/src/reference/good-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Therefore, you can check an example of Status Conditional usage by looking at it
7070
[controllers]: https://kubernetes.io/docs/concepts/architecture/controller/
7171
[controller-runtime-topic]: https://github.com/kubernetes-sigs/controller-runtime/blob/main/FAQ.md#q-how-do-i-have-different-logic-in-my-reconciler-for-different-types-of-events-eg-create-update-delete
7272
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
73-
[deploy-image]: /plugins/deploy-image-plugin-v1-alpha.md
73+
[deploy-image]: /plugins/available/deploy-image-plugin-v1-alpha.md
7474
[controller-runtime-manager]: https://github.com/kubernetes-sigs/controller-runtime/blob/304027bcbe4b3f6d582180aec5759eb4db3f17fd/pkg/manager/manager.go#L53
7575
[k8s-api-conventions]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md
7676
[k8s-control-loop]: https://kubernetes.io/docs/concepts/architecture/controller/

docs/book/src/reference/platform.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ Template: corev1.PodTemplateSpec{
134134
<h1> Example(s) </h1>
135135

136136
You can look for some code examples by checking the code which is generated via the Deploy
137-
Image plugin. ([More info](../plugins/deploy-image-plugin-v1-alpha.md))
137+
Image plugin. ([More info](../plugins/available/deploy-image-plugin-v1-alpha.md))
138138

139139
</aside>
140140

@@ -154,32 +154,31 @@ support as recommended above, and that you properly configure the [nodeAffinity]
154154
Therefore, ensure that you uncomment the following code in the `config/manager/manager.yaml` file
155155

156156
```yaml
157-
# TODO(user): Uncomment the following code to configure the nodeAffinity expression
158-
# according to the platforms which are supported by your solution.
159-
# It is considered best practice to support multiple architectures. You can
160-
# build your manager image using the makefile target docker-buildx.
161-
# affinity:
162-
# nodeAffinity:
163-
# requiredDuringSchedulingIgnoredDuringExecution:
164-
# nodeSelectorTerms:
165-
# - matchExpressions:
166-
# - key: kubernetes.io/arch
167-
# operator: In
168-
# values:
169-
# - amd64
170-
# - arm64
171-
# - ppc64le
172-
# - s390x
173-
# - key: kubernetes.io/os
174-
# operator: In
175-
# values:
176-
# - linux
157+
# TODO(user): Uncomment the following code to configure the nodeAffinity expression
158+
# according to the platforms which are supported by your solution.
159+
# It is considered best practice to support multiple architectures. You can
160+
# build your manager image using the makefile target docker-buildx.
161+
# affinity:
162+
# nodeAffinity:
163+
# requiredDuringSchedulingIgnoredDuringExecution:
164+
# nodeSelectorTerms:
165+
# - matchExpressions:
166+
# - key: kubernetes.io/arch
167+
# operator: In
168+
# values:
169+
# - amd64
170+
# - arm64
171+
# - ppc64le
172+
# - s390x
173+
# - key: kubernetes.io/os
174+
# operator: In
175+
# values:
176+
# - linux
177177
```
178178

179179
<aside class="note">
180180
<h1>Building images for releases</h1>
181181

182-
183182
You will probably want to automate the releases of your projects to ensure that the images are always built for the
184183
same platforms. Note that Goreleaser also supports [docker buildx][buildx]. See its [documentation][goreleaser-buildx] for more detail.
185184

@@ -221,4 +220,4 @@ end up labeled with ` kubernetes.io/os=linux`
221220
[node-affinity]: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#node-affinity
222221
[docker-manifest]: https://docs.docker.com/engine/reference/commandline/manifest/
223222
[buildx]: https://docs.docker.com/build/buildx/
224-
[goreleaser-buildx]: https://goreleaser.com/customization/docker/#use-a-specific-builder-with-docker-buildx
223+
[goreleaser-buildx]: https://goreleaser.com/customization/docker/#use-a-specific-builder-with-docker-buildx

docs/book/src/reference/project-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Now let's check its layout fields definition:
159159
[project]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/testdata/project-v3/PROJECT
160160
[versioning]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/VERSIONING.md#Versioning
161161
[core-types]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/pkg/plugins/golang/options.go
162-
[deploy-image-plugin]: ../plugins/deploy-image-plugin-v1-alpha.md
162+
[deploy-image-plugin]: ../plugins/available/deploy-image-plugin-v1-alpha.md
163163
[olm]: https://olm.operatorframework.io/
164164
[plugins-doc]: ../plugins/creating-plugins.html#why-use-the-kubebuilder-style
165165
[doc-design-helper]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/helper_to_upgrade_projects_by_rescaffolding.md

0 commit comments

Comments
 (0)