Skip to content

Commit

Permalink
Merge pull request kubernetes-sigs#4336 from monteiro-renato/patch-1
Browse files Browse the repository at this point in the history
📖 small fixes to extending_cli_features_and_plugins.md
  • Loading branch information
k8s-ci-robot authored Nov 20, 2024
2 parents 2cb3c51 + 0ec57ec commit 558f151
Showing 1 changed file with 5 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand All @@ -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
[upgrade-assistant]: ./../../reference/rescaffold.md

0 comments on commit 558f151

Please sign in to comment.