From 0ec57ec61f6f6985f1028f669de43c01dd0a8c2a Mon Sep 17 00:00:00 2001 From: Renato Monteiro <45536168+monteiro-renato@users.noreply.github.com> Date: Wed, 20 Nov 2024 07:36:48 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20small=20fixes=20to=20extending?= =?UTF-8?q?=5Fcli=5Ffeatures=5Fand=5Fplugins.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../extending/extending_cli_features_and_plugins.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/book/src/plugins/extending/extending_cli_features_and_plugins.md b/docs/book/src/plugins/extending/extending_cli_features_and_plugins.md index 5f794450a1a..e92a985a7f1 100644 --- a/docs/book/src/plugins/extending/extending_cli_features_and_plugins.md +++ b/docs/book/src/plugins/extending/extending_cli_features_and_plugins.md @@ -49,9 +49,9 @@ the `create api` and `create webhook` subcommands. Plugins are responsible for implementing the code that will be executed when the sub-commands are called. You can create a new plugin by implementing the [Plugin interface][plugin-interface]. -On top of being a `Base`, a plugin should also implement the [`SubcommandMetadata`][plugin-subc] -interface so it can be run with a CLI. It optionally to set custom help -text for the target command; this method can be a no-op, which will +On top of being a `Base`, a plugin should also implement the [`SubcommandMetadata`][plugin-subc-metadata] +interface so it can be run with a CLI. Optionally, a custom help +text for the target command can be set; this method can be a no-op, which will preserve the default help text set by the [cobra][cobra] command constructors. @@ -395,6 +395,7 @@ creating features or plugins that can rely on this information. [plugin-interface]: https://pkg.go.dev/sigs.k8s.io/kubebuilder/v4/pkg/plugin [machinery]: https://github.com/kubernetes-sigs/kubebuilder/tree/master/pkg/machinery [plugin-subc]: https://pkg.go.dev/sigs.k8s.io/kubebuilder/v4/pkg/plugin#Subcommand +[plugin-subc-metadata]: https://pkg.go.dev/sigs.k8s.io/kubebuilder/v4/pkg/plugin#SubcommandMetadata [plugin-version-type]: https://pkg.go.dev/sigs.k8s.io/kubebuilder/v4/pkg/plugin#Version [bundle-plugin-doc]: https://pkg.go.dev/sigs.k8s.io/kubebuilder/v4/pkg/plugin#Bundle [deprecate-plugin-doc]: https://pkg.go.dev/sigs.k8s.io/kubebuilder/v4/pkg/plugin#Deprecated @@ -408,4 +409,4 @@ creating features or plugins that can rely on this information. [cobra]: https://github.com/spf13/cobra [external-plugin]: external-plugins.md [deploy-image]: ./../available/deploy-image-plugin-v1-alpha.md -[upgrade-assistant]: ./../../reference/rescaffold.md \ No newline at end of file +[upgrade-assistant]: ./../../reference/rescaffold.md