From a44833c849547a13048426b421b711267412db25 Mon Sep 17 00:00:00 2001 From: Navid Shaikh Date: Fri, 21 Feb 2020 17:08:06 +0530 Subject: [PATCH] fix typo in source list-types examples (#684) * Fix typo in kn source list-types example * Update other list command examples --- docs/cmd/kn_revision_list.md | 2 +- docs/cmd/kn_route_list.md | 2 +- docs/cmd/kn_source_apiserver_list.md | 3 +++ docs/cmd/kn_source_binding_list.md | 5 ++++- docs/cmd/kn_source_cronjob_list.md | 3 +++ docs/cmd/kn_source_list-types.md | 2 +- pkg/kn/commands/revision/list.go | 2 +- pkg/kn/commands/route/list.go | 2 +- pkg/kn/commands/source/apiserver/list.go | 3 +++ pkg/kn/commands/source/binding/list.go | 5 ++++- pkg/kn/commands/source/cronjob/list.go | 3 +++ pkg/kn/commands/source/list_types.go | 2 +- 12 files changed, 26 insertions(+), 8 deletions(-) diff --git a/docs/cmd/kn_revision_list.md b/docs/cmd/kn_revision_list.md index 9154fb447..f132d72af 100644 --- a/docs/cmd/kn_revision_list.md +++ b/docs/cmd/kn_revision_list.md @@ -22,7 +22,7 @@ kn revision list [name] [flags] # List all revisions in JSON output format kn revision list -o json - + # List revision 'web' kn revision list web ``` diff --git a/docs/cmd/kn_route_list.md b/docs/cmd/kn_route_list.md index 65170c815..351423ad7 100644 --- a/docs/cmd/kn_route_list.md +++ b/docs/cmd/kn_route_list.md @@ -20,7 +20,7 @@ kn route list NAME [flags] # List route 'web' in namespace 'dev' kn route list web -n dev - # List all routes in yaml format + # List all routes in YAML format kn route list -o yaml ``` diff --git a/docs/cmd/kn_source_apiserver_list.md b/docs/cmd/kn_source_apiserver_list.md index e90bd2994..a1249d9d9 100644 --- a/docs/cmd/kn_source_apiserver_list.md +++ b/docs/cmd/kn_source_apiserver_list.md @@ -14,6 +14,9 @@ kn source apiserver list [flags] ``` + # List all ApiServer sources + kn source apiserver list + # List all ApiServer sources in YAML format kn source apiserver list -o yaml ``` diff --git a/docs/cmd/kn_source_binding_list.md b/docs/cmd/kn_source_binding_list.md index 3ff71b2e4..dc5966e5b 100644 --- a/docs/cmd/kn_source_binding_list.md +++ b/docs/cmd/kn_source_binding_list.md @@ -14,7 +14,10 @@ kn source binding list [flags] ``` - # List all sink binding in YAML format + # List all sink binidngs + kn source binding list + + # List all sink bindings in YAML format kn source binding list -o yaml ``` diff --git a/docs/cmd/kn_source_cronjob_list.md b/docs/cmd/kn_source_cronjob_list.md index a0fe1ab62..14ea35c4d 100644 --- a/docs/cmd/kn_source_cronjob_list.md +++ b/docs/cmd/kn_source_cronjob_list.md @@ -14,6 +14,9 @@ kn source cronjob list [flags] ``` + # List all CronJob sources + kn source cronjob list + # List all CronJob sources in YAML format kn source cronjob list -o yaml ``` diff --git a/docs/cmd/kn_source_list-types.md b/docs/cmd/kn_source_list-types.md index 16136a019..3c749a725 100644 --- a/docs/cmd/kn_source_list-types.md +++ b/docs/cmd/kn_source_list-types.md @@ -17,7 +17,7 @@ kn source list-types [flags] # List available eventing source types kn source list-types - # List available eventing source types in JSON format + # List available eventing source types in YAML format kn source list-types -o yaml ``` diff --git a/pkg/kn/commands/revision/list.go b/pkg/kn/commands/revision/list.go index a7245b4d9..7685cc2d7 100644 --- a/pkg/kn/commands/revision/list.go +++ b/pkg/kn/commands/revision/list.go @@ -50,7 +50,7 @@ func NewRevisionListCommand(p *commands.KnParams) *cobra.Command { # List all revisions in JSON output format kn revision list -o json - + # List revision 'web' kn revision list web`, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/kn/commands/route/list.go b/pkg/kn/commands/route/list.go index dea6a6dbd..ecc56d754 100644 --- a/pkg/kn/commands/route/list.go +++ b/pkg/kn/commands/route/list.go @@ -40,7 +40,7 @@ func NewRouteListCommand(p *commands.KnParams) *cobra.Command { # List route 'web' in namespace 'dev' kn route list web -n dev - # List all routes in yaml format + # List all routes in YAML format kn route list -o yaml`, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/kn/commands/source/apiserver/list.go b/pkg/kn/commands/source/apiserver/list.go index dc2ab77b0..739fedfd4 100644 --- a/pkg/kn/commands/source/apiserver/list.go +++ b/pkg/kn/commands/source/apiserver/list.go @@ -30,6 +30,9 @@ func NewAPIServerListCommand(p *commands.KnParams) *cobra.Command { Use: "list", Short: "List ApiServer sources.", Example: ` + # List all ApiServer sources + kn source apiserver list + # List all ApiServer sources in YAML format kn source apiserver list -o yaml`, diff --git a/pkg/kn/commands/source/binding/list.go b/pkg/kn/commands/source/binding/list.go index c11600fff..2efc18c5a 100644 --- a/pkg/kn/commands/source/binding/list.go +++ b/pkg/kn/commands/source/binding/list.go @@ -30,7 +30,10 @@ func NewBindingListCommand(p *commands.KnParams) *cobra.Command { Use: "list", Short: "List sink bindings.", Example: ` - # List all sink binding in YAML format + # List all sink binidngs + kn source binding list + + # List all sink bindings in YAML format kn source binding list -o yaml`, RunE: func(cmd *cobra.Command, args []string) (err error) { diff --git a/pkg/kn/commands/source/cronjob/list.go b/pkg/kn/commands/source/cronjob/list.go index 978b19907..23da1933f 100644 --- a/pkg/kn/commands/source/cronjob/list.go +++ b/pkg/kn/commands/source/cronjob/list.go @@ -30,6 +30,9 @@ func NewCronJobListCommand(p *commands.KnParams) *cobra.Command { Use: "list", Short: "List CronJob sources.", Example: ` + # List all CronJob sources + kn source cronjob list + # List all CronJob sources in YAML format kn source cronjob list -o yaml`, diff --git a/pkg/kn/commands/source/list_types.go b/pkg/kn/commands/source/list_types.go index 067a70321..38c7c82e3 100644 --- a/pkg/kn/commands/source/list_types.go +++ b/pkg/kn/commands/source/list_types.go @@ -32,7 +32,7 @@ func NewListTypesCommand(p *commands.KnParams) *cobra.Command { # List available eventing source types kn source list-types - # List available eventing source types in JSON format + # List available eventing source types in YAML format kn source list-types -o yaml`, RunE: func(cmd *cobra.Command, args []string) error { namespace, err := p.GetNamespace(cmd)