knative
/
client
mirror of https://github.com/knative/client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updates generated Cobra docs for commands and ... (#108) 

Also:

1. New docs for commands
* service get
* revision get

2. Removes auto generated docs tags

3. Auto run generated docs when building to pick up any command changes
This commit is contained in:
dr.max 2019-05-15 15:00:32 -07:00 committed by Knative Prow Robot
parent cab512c969
commit d8e710f389
14 changed files with 21 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/cmd/kn.md
View File

@ -25,4 +25,3 @@ Eventing: Manage event subscriptions and channels. Connect up event sources.
* [kn service](kn_service.md) - Service command group * [kn service](kn_service.md) - Service command group
* [kn version](kn_version.md) - Prints the client version * [kn version](kn_version.md) - Prints the client version
###### Auto generated by spf13/cobra on 3-May-2019

1
docs/cmd/kn_completion.md
View File

@ -27,4 +27,3 @@ kn completion [flags]
* [kn](kn.md) - Knative client * [kn](kn.md) - Knative client
###### Auto generated by spf13/cobra on 3-May-2019

3
docs/cmd/kn_revision.md
View File

@ -23,6 +23,5 @@ Revision command group
* [kn](kn.md) - Knative client * [kn](kn.md) - Knative client
* [kn revision describe](kn_revision_describe.md) - Describe revisions. * [kn revision describe](kn_revision_describe.md) - Describe revisions.
* [kn revision list](kn_revision_list.md) - List available revisions. * [kn revision get](kn_revision_get.md) - Get available revisions.
###### Auto generated by spf13/cobra on 3-May-2019

3
docs/cmd/kn_revision_describe.md
View File

@ -16,7 +16,7 @@ kn revision describe NAME [flags]
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true) --allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-h, --help help for describe -h, --help help for describe
-n, --namespace string List the requested object(s) in given namespace. -n, --namespace string List the requested object(s) in given namespace.
-o, --output string Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. (default "yaml") -o, --output string Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. (default "yaml")
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. --template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
``` ```
@ -31,4 +31,3 @@ kn revision describe NAME [flags]
* [kn revision](kn_revision.md) - Revision command group * [kn revision](kn_revision.md) - Revision command group
###### Auto generated by spf13/cobra on 3-May-2019

13
docs/cmd/kn_revision_list.md → docs/cmd/kn_revision_get.md
View File

@ -1,13 +1,13 @@
## kn revision list ## kn revision get
List available revisions. Get available revisions.
### Synopsis ### Synopsis
List available revisions. Get available revisions.
``` ```
kn revision list [flags] kn revision get [flags]
``` ```
### Options ### Options
@ -15,9 +15,9 @@ kn revision list [flags]
``` ```
--all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true) --allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-h, --help help for list -h, --help help for get
-n, --namespace string List the requested object(s) in given namespace. -n, --namespace string List the requested object(s) in given namespace.
-o, --output string Output format. One of: json|yaml|name|template|go-template|go-template-file|templatefile|jsonpath|jsonpath-file. (default "jsonpath={range .items[*]}{.metadata.name}{\"\\n\"}{end}") -o, --output string Output format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. --template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
``` ```
@ -32,4 +32,3 @@ kn revision list [flags]
* [kn revision](kn_revision.md) - Revision command group * [kn revision](kn_revision.md) - Revision command group
###### Auto generated by spf13/cobra on 3-May-2019

3
docs/cmd/kn_service.md
View File

@ -25,7 +25,6 @@ Service command group
* [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) - Describe available services. * [kn service describe](kn_service_describe.md) - Describe available services.
* [kn service list](kn_service_list.md) - List available services. * [kn service get](kn_service_get.md) - Get available services.
* [kn service update](kn_service_update.md) - Update a service. * [kn service update](kn_service_update.md) - Update a service.
###### Auto generated by spf13/cobra on 3-May-2019

1
docs/cmd/kn_service_create.md
View File

@ -45,4 +45,3 @@ kn service create NAME --image IMAGE [flags]
* [kn service](kn_service.md) - Service command group * [kn service](kn_service.md) - Service command group
###### Auto generated by spf13/cobra on 3-May-2019

1
docs/cmd/kn_service_delete.md
View File

@ -39,4 +39,3 @@ kn service delete NAME [flags]
* [kn service](kn_service.md) - Service command group * [kn service](kn_service.md) - Service command group
###### Auto generated by spf13/cobra on 3-May-2019

1
docs/cmd/kn_service_describe.md
View File

@ -31,4 +31,3 @@ kn service describe NAME [flags]
* [kn service](kn_service.md) - Service command group * [kn service](kn_service.md) - Service command group
###### Auto generated by spf13/cobra on 3-May-2019

13
docs/cmd/kn_service_list.md → docs/cmd/kn_service_get.md
View File

@ -1,13 +1,13 @@
## kn service list ## kn service get
List available services. Get available services.
### Synopsis ### Synopsis
List available services. Get available services.
``` ```
kn service list [flags] kn service get [flags]
``` ```
### Options ### Options
@ -15,9 +15,9 @@ kn service list [flags]
``` ```
--all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace. --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
--allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true) --allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true)
-h, --help help for list -h, --help help for get
-n, --namespace string List the requested object(s) in given namespace. -n, --namespace string List the requested object(s) in given namespace.
-o, --output string Output format. One of: json|yaml|name|go-template|go-template-file|templatefile|template|jsonpath|jsonpath-file. (default "jsonpath={range .items[*]}{.metadata.name}{\"\\n\"}{end}") -o, --output string Output format. One of: json|yaml|name|go-template-file|templatefile|template|go-template|jsonpath|jsonpath-file.
--template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. --template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
``` ```
@ -32,4 +32,3 @@ kn service list [flags]
* [kn service](kn_service.md) - Service command group * [kn service](kn_service.md) - Service command group
###### Auto generated by spf13/cobra on 3-May-2019

1
docs/cmd/kn_service_update.md
View File

@ -45,4 +45,3 @@ kn service update NAME [flags]
* [kn service](kn_service.md) - Service command group * [kn service](kn_service.md) - Service command group
###### Auto generated by spf13/cobra on 3-May-2019

1
docs/cmd/kn_version.md
View File

@ -27,4 +27,3 @@ kn version [flags]
* [kn](kn.md) - Knative client * [kn](kn.md) - Knative client
###### Auto generated by spf13/cobra on 3-May-2019

3
hack/build.sh
View File

@ -28,4 +28,7 @@ go fmt ${base}/cmd/... ${base}/pkg/...
echo "🚧 Building" echo "🚧 Building"
go build -mod=vendor -ldflags "$(ld_flags ${base}/hack)" -o ${base}/kn ${base}/cmd/... go build -mod=vendor -ldflags "$(ld_flags ${base}/hack)" -o ${base}/kn ${base}/cmd/...
echo "🌞 Success" echo "🌞 Success"
${base}/hack/generate-docs.sh
${base}/kn version ${base}/kn version

3
pkg/kn/commands/root.go
View File

@ -66,6 +66,9 @@ Serving: Manage your services and release new software to them.
Build: Create builds and keep track of their results. Build: Create builds and keep track of their results.
Eventing: Manage event subscriptions and channels. Connect up event sources.`, Eventing: Manage event subscriptions and channels. Connect up event sources.`,
// Disable docs header
DisableAutoGenTag: true,
// Affects children as well // Affects children as well
SilenceUsage: true, SilenceUsage: true,