Skip to content

Commit 558f151

Browse files
authored
Merge pull request #4336 from monteiro-renato/patch-1
📖 small fixes to extending_cli_features_and_plugins.md
2 parents 2cb3c51 + 0ec57ec commit 558f151

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/book/src/plugins/extending/extending_cli_features_and_plugins.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ the `create api` and `create webhook` subcommands.
4949
Plugins are responsible for implementing the code that will be executed when the sub-commands are called.
5050
You can create a new plugin by implementing the [Plugin interface][plugin-interface].
5151

52-
On top of being a `Base`, a plugin should also implement the [`SubcommandMetadata`][plugin-subc]
53-
interface so it can be run with a CLI. It optionally to set custom help
54-
text for the target command; this method can be a no-op, which will
52+
On top of being a `Base`, a plugin should also implement the [`SubcommandMetadata`][plugin-subc-metadata]
53+
interface so it can be run with a CLI. Optionally, a custom help
54+
text for the target command can be set; this method can be a no-op, which will
5555
preserve the default help text set by the [cobra][cobra] command
5656
constructors.
5757

@@ -395,6 +395,7 @@ creating features or plugins that can rely on this information.
395395
[plugin-interface]: https://pkg.go.dev/sigs.k8s.io/kubebuilder/v4/pkg/plugin
396396
[machinery]: https://github.com/kubernetes-sigs/kubebuilder/tree/master/pkg/machinery
397397
[plugin-subc]: https://pkg.go.dev/sigs.k8s.io/kubebuilder/v4/pkg/plugin#Subcommand
398+
[plugin-subc-metadata]: https://pkg.go.dev/sigs.k8s.io/kubebuilder/v4/pkg/plugin#SubcommandMetadata
398399
[plugin-version-type]: https://pkg.go.dev/sigs.k8s.io/kubebuilder/v4/pkg/plugin#Version
399400
[bundle-plugin-doc]: https://pkg.go.dev/sigs.k8s.io/kubebuilder/v4/pkg/plugin#Bundle
400401
[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.
408409
[cobra]: https://github.com/spf13/cobra
409410
[external-plugin]: external-plugins.md
410411
[deploy-image]: ./../available/deploy-image-plugin-v1-alpha.md
411-
[upgrade-assistant]: ./../../reference/rescaffold.md
412+
[upgrade-assistant]: ./../../reference/rescaffold.md

0 commit comments

Comments
 (0)