Permalink
Browse files

Merge pull request #469 from imjoey/improve_cmd_desc

Improve the commands descriptions
  • Loading branch information...
k8s-ci-robot committed Nov 14, 2018
2 parents 388230d + 6588609 commit aca81e190187e80617209552b6a760dadb9862bb
Showing with 9 additions and 9 deletions.
  1. +1 −1 cmd/alpha.go
  2. +2 −2 cmd/docs.go
  3. +2 −2 cmd/main.go
  4. +2 −2 cmd/vendor_update.go
  5. +2 −2 cmd/version/version.go
@@ -25,7 +25,7 @@ import (
func newAlphaCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "alpha",
Short: "Exposes commands which are in experimental or early stages of development",
Short: "Expose commands which are in experimental or early stages of development",
Long: `Command group for commands which are either experimental or in early stages of development`,
Example: `
# scaffolds webhook server
@@ -24,8 +24,8 @@ import (
func newDocsCmd() *cobra.Command {
return &cobra.Command{
Use: "docs",
Short: "Generate API reference docs. Coming soon.",
Long: `updates vendor dependencies. Coming soon.`,
Short: "Generate API reference docs. Coming soon",
Long: `Update vendor dependencies. Coming soon`,
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("Coming soon.")
},
@@ -83,8 +83,8 @@ Typical project lifecycle:
kubebuilder create api --group <group> --version <version> --kind <Kind>
create resource will prompt the user for if it should scaffold the Resource and / or Controller. To only
scaffold a Controller for an existing Resource, select "n" for Resource. To only define
Create resource will prompt the user for if it should scaffold the Resource and / or Controller. To only
scaffold a Controller for an existing Resource, select "n" for Resource. To only define
the schema for a Resource without writing a Controller, select "n" for Controller.
After the scaffold is written, api will run make on the project.
@@ -28,8 +28,8 @@ import (
func newVendorUpdateCmd() *cobra.Command {
return &cobra.Command{
Use: "update",
Short: "updates vendor dependencies.",
Long: `updates vendor dependencies.`,
Short: "Update vendor dependencies",
Long: `Update vendor dependencies`,
Example: `Update the vendor dependencies:
kubebuilder update vendor
`,
@@ -59,8 +59,8 @@ func (v Version) Print() {
func NewVersionCmd() *cobra.Command {
return &cobra.Command{
Use: "version",
Short: "Print the kubebuilder version.",
Long: `Print the kubebuilder version.`,
Short: "Print the kubebuilder version",
Long: `Print the kubebuilder version`,
Example: `kubebuilder version`,
Run: runVersion,
}

0 comments on commit aca81e1

Please sign in to comment.