diff options
| -rw-r--r-- | kubectl-conventions.md | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/kubectl-conventions.md b/kubectl-conventions.md index fe2e51a1..dd388a61 100644 --- a/kubectl-conventions.md +++ b/kubectl-conventions.md @@ -301,24 +301,25 @@ Sample command skeleton: // MineRecommendedName is the recommended command name for kubectl mine. const MineRecommendedName = "mine" -// MineConfig contains all the options for running the mine cli command. -type MineConfig struct { - mineLatest bool -} - +// Long command description and examples. var ( - mineLong = dedent.Dedent(` - mine which is described here - with lots of details.`) + mineLong = templates.LongDesc(` + mine which is described here + with lots of details.`) - mineExample = dedent.Dedent(` - # Run my command's first action - kubectl mine first_action + mineExample = templates.Examples(` + # Run my command's first action + kubectl mine first_action - # Run my command's second action on latest stuff - kubectl mine second_action --flag`) + # Run my command's second action on latest stuff + kubectl mine second_action --flag`) ) +// MineConfig contains all the options for running the mine cli command. +type MineConfig struct { + mineLatest bool +} + // NewCmdMine implements the kubectl mine command. func NewCmdMine(parent, name string, f *cmdutil.Factory, out io.Writer) *cobra.Command { opts := &MineConfig{} |