fix(docs): Revert markdown changes for cobra's auto-docs (#715)

Revert sub-set of changes from https://github.com/knative/client/pull/710 which
 are auto-generated by cobra.
This commit is contained in:
Navid Shaikh 2020-03-09 22:28:29 +05:30 committed by GitHub
parent f9ccf36518
commit 21ce981963
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
44 changed files with 143 additions and 117 deletions

View File

@ -6,8 +6,8 @@ Knative client
Manage your Knative building blocks: Manage your Knative building blocks:
- Serving: Manage your services and release new software to them. * Serving: Manage your services and release new software to them.
- Eventing: Manage event subscriptions and channels. Connect up event sources. * Eventing: Manage event subscriptions and channels. Connect up event sources.
### Options ### Options
@ -22,11 +22,12 @@ Manage your Knative building blocks:
### SEE ALSO ### SEE ALSO
- [kn completion](kn_completion.md) - Output shell completion code * [kn completion](kn_completion.md) - Output shell completion code
- [kn plugin](kn_plugin.md) - Plugin command group * [kn plugin](kn_plugin.md) - Plugin command group
- [kn revision](kn_revision.md) - Revision command group * [kn revision](kn_revision.md) - Revision command group
- [kn route](kn_route.md) - Route command group * [kn route](kn_route.md) - Route command group
- [kn service](kn_service.md) - Service command group * [kn service](kn_service.md) - Service command group
- [kn source](kn_source.md) - Event source command group * [kn source](kn_source.md) - Event source command group
- [kn trigger](kn_trigger.md) - Trigger command group * [kn trigger](kn_trigger.md) - Trigger command group
- [kn version](kn_version.md) - Prints the client version * [kn version](kn_version.md) - Prints the client version

View File

@ -4,13 +4,13 @@ Output shell completion code
### Synopsis ### Synopsis
This command prints shell completion code which needs to be evaluated to provide
interactive completion This command prints shell completion code which needs to be evaluated
to provide interactive completion
Supported Shells: Supported Shells:
- bash
- bash - zsh
- zsh
``` ```
kn completion [SHELL] [flags] kn completion [SHELL] [flags]
@ -43,4 +43,5 @@ kn completion [SHELL] [flags]
### SEE ALSO ### SEE ALSO
- [kn](kn.md) - Knative client * [kn](kn.md) - Knative client

View File

@ -6,9 +6,8 @@ Plugin command group
Provides utilities for interacting and managing with kn plugins. Provides utilities for interacting and managing with kn plugins.
Plugins provide extended functionality that is not part of the core kn Plugins provide extended functionality that is not part of the core kn command-line distribution.
command-line distribution. Please refer to the documentation and examples for Please refer to the documentation and examples for more information about how write your own plugins.
more information about how write your own plugins.
``` ```
kn plugin [flags] kn plugin [flags]
@ -32,5 +31,6 @@ kn plugin [flags]
### SEE ALSO ### SEE ALSO
- [kn](kn.md) - Knative client * [kn](kn.md) - Knative client
- [kn plugin list](kn_plugin_list.md) - List plugins * [kn plugin list](kn_plugin_list.md) - List plugins

View File

@ -7,11 +7,10 @@ List plugins
List all installed plugins. List all installed plugins.
Available plugins are those that are: Available plugins are those that are:
- executable - executable
- begin with "kn-" - begin with "kn-"
- Kn's plugin directory ~/.config/kn/plugins - Kn's plugin directory ~/.config/kn/plugins
- Anywhere in the execution \$PATH (if lookupInPath config variable is enabled) - Anywhere in the execution $PATH (if lookupInPath config variable is enabled)
``` ```
kn plugin list [flags] kn plugin list [flags]
@ -37,4 +36,5 @@ kn plugin list [flags]
### SEE ALSO ### SEE ALSO
- [kn plugin](kn_plugin.md) - Plugin command group * [kn plugin](kn_plugin.md) - Plugin command group

View File

@ -26,7 +26,8 @@ kn revision [flags]
### SEE ALSO ### SEE ALSO
- [kn](kn.md) - Knative client * [kn](kn.md) - Knative client
- [kn revision delete](kn_revision_delete.md) - Delete a revision. * [kn revision delete](kn_revision_delete.md) - Delete a revision.
- [kn revision describe](kn_revision_describe.md) - Show details of a revision * [kn revision describe](kn_revision_describe.md) - Show details of a revision
- [kn revision list](kn_revision_list.md) - List available revisions. * [kn revision list](kn_revision_list.md) - List available revisions.

View File

@ -38,4 +38,5 @@ kn revision delete NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn revision](kn_revision.md) - Revision command group * [kn revision](kn_revision.md) - Revision command group

View File

@ -31,4 +31,5 @@ kn revision describe NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn revision](kn_revision.md) - Revision command group * [kn revision](kn_revision.md) - Revision command group

View File

@ -50,4 +50,5 @@ kn revision list [name] [flags]
### SEE ALSO ### SEE ALSO
- [kn revision](kn_revision.md) - Revision command group * [kn revision](kn_revision.md) - Revision command group

View File

@ -26,6 +26,7 @@ kn route [flags]
### SEE ALSO ### SEE ALSO
- [kn](kn.md) - Knative client * [kn](kn.md) - Knative client
- [kn route describe](kn_route_describe.md) - Show details of a route * [kn route describe](kn_route_describe.md) - Show details of a route
- [kn route list](kn_route_list.md) - List available routes. * [kn route list](kn_route_list.md) - List available routes.

View File

@ -31,4 +31,5 @@ kn route describe NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn route](kn_route.md) - Route command group * [kn route](kn_route.md) - Route command group

View File

@ -46,4 +46,5 @@ kn route list NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn route](kn_route.md) - Route command group * [kn route](kn_route.md) - Route command group

View File

@ -26,9 +26,10 @@ kn service [flags]
### SEE ALSO ### SEE ALSO
- [kn](kn.md) - Knative client * [kn](kn.md) - Knative client
- [kn service create](kn_service_create.md) - Create a service. * [kn service create](kn_service_create.md) - Create a service.
- [kn service delete](kn_service_delete.md) - Delete a service. * [kn service delete](kn_service_delete.md) - Delete a service.
- [kn service describe](kn_service_describe.md) - Show details of a service * [kn service describe](kn_service_describe.md) - Show details of a service
- [kn service list](kn_service_list.md) - List available services. * [kn service list](kn_service_list.md) - List available services.
- [kn service update](kn_service_update.md) - Update a service. * [kn service update](kn_service_update.md) - Update a service.

View File

@ -85,4 +85,5 @@ kn service create NAME --image IMAGE [flags]
### SEE ALSO ### SEE ALSO
- [kn service](kn_service.md) - Service command group * [kn service](kn_service.md) - Service command group

View File

@ -41,4 +41,5 @@ kn service delete NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn service](kn_service.md) - Service command group * [kn service](kn_service.md) - Service command group

View File

@ -31,4 +31,5 @@ kn service describe NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn service](kn_service.md) - Service command group * [kn service](kn_service.md) - Service command group

View File

@ -46,4 +46,5 @@ kn service list [name] [flags]
### SEE ALSO ### SEE ALSO
- [kn service](kn_service.md) - Service command group * [kn service](kn_service.md) - Service command group

View File

@ -83,4 +83,5 @@ kn service update NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn service](kn_service.md) - Service command group * [kn service](kn_service.md) - Service command group

View File

@ -26,9 +26,9 @@ kn source [flags]
### SEE ALSO ### SEE ALSO
- [kn](kn.md) - Knative client * [kn](kn.md) - Knative client
- [kn source apiserver](kn_source_apiserver.md) - Kubernetes API Server Event * [kn source apiserver](kn_source_apiserver.md) - Kubernetes API Server Event Source command group
Source command group * [kn source binding](kn_source_binding.md) - Sink binding command group
- [kn source binding](kn_source_binding.md) - Sink binding command group * [kn source list-types](kn_source_list-types.md) - List available source types
- [kn source list-types](kn_source_list-types.md) - List available source types * [kn source ping](kn_source_ping.md) - Ping source command group
- [kn source ping](kn_source_ping.md) - Ping source command group

View File

@ -26,14 +26,10 @@ kn source apiserver [flags]
### SEE ALSO ### SEE ALSO
- [kn source](kn_source.md) - Event source command group * [kn source](kn_source.md) - Event source command group
- [kn source apiserver create](kn_source_apiserver_create.md) - Create an * [kn source apiserver create](kn_source_apiserver_create.md) - Create an ApiServer source.
ApiServer source. * [kn source apiserver delete](kn_source_apiserver_delete.md) - Delete an ApiServer source.
- [kn source apiserver delete](kn_source_apiserver_delete.md) - Delete an * [kn source apiserver describe](kn_source_apiserver_describe.md) - Show details of an ApiServer source
ApiServer source. * [kn source apiserver list](kn_source_apiserver_list.md) - List ApiServer sources.
- [kn source apiserver describe](kn_source_apiserver_describe.md) - Show details * [kn source apiserver update](kn_source_apiserver_update.md) - Update an ApiServer source.
of an ApiServer source
- [kn source apiserver list](kn_source_apiserver_list.md) - List ApiServer
sources.
- [kn source apiserver update](kn_source_apiserver_update.md) - Update an
ApiServer source.

View File

@ -42,5 +42,5 @@ kn source apiserver create NAME --resource RESOURCE --service-account ACCOUNTNAM
### SEE ALSO ### SEE ALSO
- [kn source apiserver](kn_source_apiserver.md) - Kubernetes API Server Event * [kn source apiserver](kn_source_apiserver.md) - Kubernetes API Server Event Source command group
Source command group

View File

@ -35,5 +35,5 @@ kn source apiserver delete NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn source apiserver](kn_source_apiserver.md) - Kubernetes API Server Event * [kn source apiserver](kn_source_apiserver.md) - Kubernetes API Server Event Source command group
Source command group

View File

@ -36,5 +36,5 @@ kn source apiserver describe NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn source apiserver](kn_source_apiserver.md) - Kubernetes API Server Event * [kn source apiserver](kn_source_apiserver.md) - Kubernetes API Server Event Source command group
Source command group

View File

@ -43,5 +43,5 @@ kn source apiserver list [flags]
### SEE ALSO ### SEE ALSO
- [kn source apiserver](kn_source_apiserver.md) - Kubernetes API Server Event * [kn source apiserver](kn_source_apiserver.md) - Kubernetes API Server Event Source command group
Source command group

View File

@ -42,5 +42,5 @@ kn source apiserver update NAME --resource RESOURCE --service-account ACCOUNTNAM
### SEE ALSO ### SEE ALSO
- [kn source apiserver](kn_source_apiserver.md) - Kubernetes API Server Event * [kn source apiserver](kn_source_apiserver.md) - Kubernetes API Server Event Source command group
Source command group

View File

@ -26,13 +26,10 @@ kn source binding [flags]
### SEE ALSO ### SEE ALSO
- [kn source](kn_source.md) - Event source command group * [kn source](kn_source.md) - Event source command group
- [kn source binding create](kn_source_binding_create.md) - Create a sink * [kn source binding create](kn_source_binding_create.md) - Create a sink binding.
binding. * [kn source binding delete](kn_source_binding_delete.md) - Delete a sink binding.
- [kn source binding delete](kn_source_binding_delete.md) - Delete a sink * [kn source binding describe](kn_source_binding_describe.md) - Show details of a sink binding
binding. * [kn source binding list](kn_source_binding_list.md) - List sink bindings.
- [kn source binding describe](kn_source_binding_describe.md) - Show details of * [kn source binding update](kn_source_binding_update.md) - Update a sink binding.
a sink binding
- [kn source binding list](kn_source_binding_list.md) - List sink bindings.
- [kn source binding update](kn_source_binding_update.md) - Update a sink
binding.

View File

@ -38,4 +38,5 @@ kn source binding create NAME --subject SCHEDULE --sink SINK --ce-override KEY=V
### SEE ALSO ### SEE ALSO
- [kn source binding](kn_source_binding.md) - Sink binding command group * [kn source binding](kn_source_binding.md) - Sink binding command group

View File

@ -35,4 +35,5 @@ kn source binding delete NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn source binding](kn_source_binding.md) - Sink binding command group * [kn source binding](kn_source_binding.md) - Sink binding command group

View File

@ -36,4 +36,5 @@ kn source binding describe NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn source binding](kn_source_binding.md) - Sink binding command group * [kn source binding](kn_source_binding.md) - Sink binding command group

View File

@ -43,4 +43,5 @@ kn source binding list [flags]
### SEE ALSO ### SEE ALSO
- [kn source binding](kn_source_binding.md) - Sink binding command group * [kn source binding](kn_source_binding.md) - Sink binding command group

View File

@ -14,7 +14,7 @@ kn source binding update NAME --subject SCHEDULE --sink SINK --ce-override OVERR
``` ```
# Update the subject of a sink binding 'my-binding' to a new cronjob with label selector 'app=ping' # Update the subject of a sink binding 'my-binding' to a new cronjob with label selector 'app=ping'
kn source binding update my-binding --subject cronjob:batch/v1beta1:app=ping" kn source binding update my-binding --subject cronjob:batch/v1beta1:app=ping"
``` ```
@ -38,4 +38,5 @@ kn source binding update NAME --subject SCHEDULE --sink SINK --ce-override OVERR
### SEE ALSO ### SEE ALSO
- [kn source binding](kn_source_binding.md) - Sink binding command group * [kn source binding](kn_source_binding.md) - Sink binding command group

View File

@ -42,4 +42,5 @@ kn source list-types [flags]
### SEE ALSO ### SEE ALSO
- [kn source](kn_source.md) - Event source command group * [kn source](kn_source.md) - Event source command group

View File

@ -26,10 +26,10 @@ kn source ping [flags]
### SEE ALSO ### SEE ALSO
- [kn source](kn_source.md) - Event source command group * [kn source](kn_source.md) - Event source command group
- [kn source ping create](kn_source_ping_create.md) - Create a Ping source. * [kn source ping create](kn_source_ping_create.md) - Create a Ping source.
- [kn source ping delete](kn_source_ping_delete.md) - Delete a Ping source. * [kn source ping delete](kn_source_ping_delete.md) - Delete a Ping source.
- [kn source ping describe](kn_source_ping_describe.md) - Show details of a Ping * [kn source ping describe](kn_source_ping_describe.md) - Show details of a Ping source
source * [kn source ping list](kn_source_ping_list.md) - List Ping sources.
- [kn source ping list](kn_source_ping_list.md) - List Ping sources. * [kn source ping update](kn_source_ping_update.md) - Update a Ping source.
- [kn source ping update](kn_source_ping_update.md) - Update a Ping source.

View File

@ -38,4 +38,5 @@ kn source ping create NAME --schedule SCHEDULE --sink SINK --data DATA [flags]
### SEE ALSO ### SEE ALSO
- [kn source ping](kn_source_ping.md) - Ping source command group * [kn source ping](kn_source_ping.md) - Ping source command group

View File

@ -35,4 +35,5 @@ kn source ping delete NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn source ping](kn_source_ping.md) - Ping source command group * [kn source ping](kn_source_ping.md) - Ping source command group

View File

@ -36,4 +36,5 @@ kn source ping describe NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn source ping](kn_source_ping.md) - Ping source command group * [kn source ping](kn_source_ping.md) - Ping source command group

View File

@ -43,4 +43,5 @@ kn source ping list [flags]
### SEE ALSO ### SEE ALSO
- [kn source ping](kn_source_ping.md) - Ping source command group * [kn source ping](kn_source_ping.md) - Ping source command group

View File

@ -38,4 +38,5 @@ kn source ping update NAME --schedule SCHEDULE --sink SERVICE --data DATA [flags
### SEE ALSO ### SEE ALSO
- [kn source ping](kn_source_ping.md) - Ping source command group * [kn source ping](kn_source_ping.md) - Ping source command group

View File

@ -26,9 +26,10 @@ kn trigger [flags]
### SEE ALSO ### SEE ALSO
- [kn](kn.md) - Knative client * [kn](kn.md) - Knative client
- [kn trigger create](kn_trigger_create.md) - Create a trigger * [kn trigger create](kn_trigger_create.md) - Create a trigger
- [kn trigger delete](kn_trigger_delete.md) - Delete a trigger. * [kn trigger delete](kn_trigger_delete.md) - Delete a trigger.
- [kn trigger describe](kn_trigger_describe.md) - Show details of a trigger * [kn trigger describe](kn_trigger_describe.md) - Show details of a trigger
- [kn trigger list](kn_trigger_list.md) - List available triggers. * [kn trigger list](kn_trigger_list.md) - List available triggers.
- [kn trigger update](kn_trigger_update.md) - Update a trigger * [kn trigger update](kn_trigger_update.md) - Update a trigger

View File

@ -38,4 +38,5 @@ kn trigger create NAME --broker BROKER --filter KEY=VALUE --sink SINK [flags]
### SEE ALSO ### SEE ALSO
- [kn trigger](kn_trigger.md) - Trigger command group * [kn trigger](kn_trigger.md) - Trigger command group

View File

@ -35,4 +35,5 @@ kn trigger delete NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn trigger](kn_trigger.md) - Trigger command group * [kn trigger](kn_trigger.md) - Trigger command group

View File

@ -36,4 +36,5 @@ kn trigger describe NAME [flags]
### SEE ALSO ### SEE ALSO
- [kn trigger](kn_trigger.md) - Trigger command group * [kn trigger](kn_trigger.md) - Trigger command group

View File

@ -43,4 +43,5 @@ kn trigger list [name] [flags]
### SEE ALSO ### SEE ALSO
- [kn trigger](kn_trigger.md) - Trigger command group * [kn trigger](kn_trigger.md) - Trigger command group

View File

@ -17,12 +17,12 @@ kn trigger update NAME --filter KEY=VALUE --sink SINK [flags]
# Update the filter which key is 'type' to value 'knative.dev.bar' in a trigger 'mytrigger' # Update the filter which key is 'type' to value 'knative.dev.bar' in a trigger 'mytrigger'
kn trigger update mytrigger --filter type=knative.dev.bar kn trigger update mytrigger --filter type=knative.dev.bar
# Remove the filter which key is 'type' from a trigger 'mytrigger' # Remove the filter which key is 'type' from a trigger 'mytrigger'
kn trigger update mytrigger --filter type- kn trigger update mytrigger --filter type-
# Update the sink of a trigger 'mytrigger' to 'svc:new-service' # Update the sink of a trigger 'mytrigger' to 'svc:new-service'
kn trigger update mytrigger --sink svc:new-service kn trigger update mytrigger --sink svc:new-service
``` ```
### Options ### Options
@ -45,4 +45,5 @@ kn trigger update NAME --filter KEY=VALUE --sink SINK [flags]
### SEE ALSO ### SEE ALSO
- [kn trigger](kn_trigger.md) - Trigger command group * [kn trigger](kn_trigger.md) - Trigger command group

View File

@ -26,4 +26,5 @@ kn version [flags]
### SEE ALSO ### SEE ALSO
- [kn](kn.md) - Knative client * [kn](kn.md) - Knative client