Skip to content

Commit

Permalink
fixing doc links so ci passes
Browse files Browse the repository at this point in the history
Signed-off-by: Adam D. Cornett <[email protected]>
  • Loading branch information
acornett21 committed Oct 30, 2024
1 parent a268c70 commit fc965d0
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Your operator metrics `help` message should include the following details:
- What does the output mean?
- What important labels does the metric use? (Optional. If applicable).

The `Help` message can be used to create auto-generated documentation, like it's done in [KubeVirt](https://github.com/kubevirt/kubevirt/blob/main/docs/metrics.md) and generated by the [KubeVirt metrics doc generator](https://github.com/kubevirt/kubevirt/blob/main/tools/doc-generator/doc-generator.go).
The `Help` message can be used to create auto-generated documentation, like it's done in [KubeVirt](https://github.com/kubevirt/kubevirt/blob/main/docs/observability/metrics.md) and generated by the [KubeVirt metrics doc generator](https://github.com/kubevirt/kubevirt/blob/main/tools/doc-generator/doc-generator.go).

We recommend to auto-generated metrics documentation and save it in your operator repository, to a location like `/docs/monitoring/`, so that the users can find the information about your operator metrics easily.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ Next, check out the following:
[controller_tools]: https://sigs.k8s.io/controller-tools
[crd-markers]: https://book.kubebuilder.io/reference/markers/crd-validation.html
[create_a_webhook]: /docs/building-operators/golang/webhook
[deploy-image-plugin-doc]: https://master.book.kubebuilder.io/plugins/deploy-image-plugin-v1-alpha.html
[deploy-image-plugin-doc]: https://book.kubebuilder.io/plugins/available/deploy-image-plugin-v1-alpha
[doc-bundle]:https://github.com/operator-framework/operator-registry/blob/v1.16.1/docs/design/operator-bundle.md#operator-bundle
[doc-olm]:/docs/olm-integration/tutorial-bundle/#enabling-olm
[doc-validation-schema]: https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#specifying-a-structural-schema
Expand Down
6 changes: 3 additions & 3 deletions website/content/en/docs/contribution-guidelines/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The specific files for each language are scaffolded for the language's plugins.
operator-sdk init --plugins=kustomize
```

Also, see the topic [Language-based Plugins][kb-language-plugins] to understand how it works.
Also, see the topic [External Plugins][kb-language-plugins] to understand how it works.

### Common scaffolds

Expand Down Expand Up @@ -63,7 +63,7 @@ If you are looking to develop similar solutions to allow users for example to cr

[kb-plugins-doc]: https://master.book.kubebuilder.io/plugins/plugins.html
[kb-int-sdk]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/integrating-kubebuilder-and-osdk.md
[kb-language-plugins]:https://master.book.kubebuilder.io/plugins/creating-plugins.html#language-based-plugins
[kb-language-plugins]: https://book.kubebuilder.io/plugins/extending/external-plugins
[kustomize]: https://github.com/kubernetes-sigs/kustomize
[bundle]: https://github.com/operator-framework/operator-registry/blob/v1.16.1/docs/design/operator-bundle.md#operator-bundle
[kb-project]: https://master.book.kubebuilder.io/reference/project-config.html
Expand All @@ -75,6 +75,6 @@ If you are looking to develop similar solutions to allow users for example to cr
[kubebuilder-declarative-pattern-example]: https://github.com/kubernetes-sigs/kubebuilder/blob/v3.13.0/testdata/project-v3/controllers/firstmate_controller.go
[default-scaffold]: https://github.com/kubernetes-sigs/kubebuilder/blob/v3.13.0/testdata/project-v3/controllers/admiral_controller.go
[kb-issue]: https://github.com/kubernetes-sigs/kubebuilder/issues/1378
[create-your-own-plugins]: https://master.book.kubebuilder.io/plugins/creating-plugins.html
[create-your-own-plugins]: https://book.kubebuilder.io/plugins/extending
[scorecard]: /docs/testing-operators/scorecard/
[kubebuilder]: https://github.com/kubernetes-sigs/kubebuilder
2 changes: 1 addition & 1 deletion website/content/en/docs/overview/operator-capabilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,6 @@ The highest capability level aims to significantly reduce/eliminate any remainin
[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
[metrics]: https://book.kubebuilder.io/reference/metrics.html
[metric-reference]: https://book.kubebuilder.io/reference/metrics-reference.html
[grafana-plugin-docs]: https://book.kubebuilder.io/plugins/grafana-v1-alpha.html
[grafana-plugin-docs]: https://book.kubebuilder.io/plugins/available/grafana-v1-alpha
[k8s-api-events]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#events
[k8s-api-status]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
2 changes: 1 addition & 1 deletion website/content/en/docs/upgrading-sdk-version/v1.33.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ _See [#6613](https://github.com/operator-framework/operator-sdk/pull/6613) for m
## (kustomize/v2-alpha) Move kustomize/v2 plugin from alpha to stable

For more information on the kustomize/v2 plugin, please refer to the documentation at
https://book.kubebuilder.io/plugins/kustomize-v2
https://book.kubebuilder.io/plugins/available/kustomize-v2

_See [#6613](https://github.com/operator-framework/operator-sdk/pull/6613) for more details._

0 comments on commit fc965d0

Please sign in to comment.