From 7baabf7a9752ec11bcadf3fcd58ffcf6ec5e8d9e Mon Sep 17 00:00:00 2001 From: Phillip Wittrock Date: Mon, 25 Nov 2019 10:31:33 -0800 Subject: [PATCH] cmd/config: mark `config` command group as [Alpha] --- cmd/config/cmddocs/commands/docs.go | 28 ++++++++++++++-------------- cmd/config/cmds/cmds.go | 12 ++++++------ cmd/config/docs/commands/cat.md | 4 ++-- cmd/config/docs/commands/count.md | 4 ++-- cmd/config/docs/commands/fmt.md | 4 ++-- cmd/config/docs/commands/grep.md | 4 ++-- cmd/config/docs/commands/merge.md | 4 ++-- cmd/config/docs/commands/run-fns.md | 4 ++-- cmd/config/docs/commands/tree.md | 4 ++-- 9 files changed, 34 insertions(+), 34 deletions(-) diff --git a/cmd/config/cmddocs/commands/docs.go b/cmd/config/cmddocs/commands/docs.go index dea7a3047..a7e9bcec5 100644 --- a/cmd/config/cmddocs/commands/docs.go +++ b/cmd/config/cmddocs/commands/docs.go @@ -4,9 +4,9 @@ // Code generated by "mdtogo"; DO NOT EDIT. package commands -var CatShort = `Print Resource Config from a local directory.` +var CatShort = `[Alpha] Print Resource Config from a local directory.` var CatLong = ` -Print Resource Config from a local directory. +[Alpha] Print Resource Config from a local directory. DIR: Path to local directory. @@ -21,9 +21,9 @@ var CatExamples = ` # unwrap Resource config from a directory in an ResourceList ... | kyaml cat` -var CountShort = `Count Resources Config from a local directory.` +var CountShort = `[Alpha] Count Resources Config from a local directory.` var CountLong = ` -Count Resources Config from a local directory. +[Alpha] Count Resources Config from a local directory. DIR: Path to local directory. @@ -32,9 +32,9 @@ var CountExamples = ` # print Resource counts from a directory kyaml count my-dir/` -var FmtShort = `Format yaml configuration files.` +var FmtShort = `[Alpha] Format yaml configuration files.` var FmtLong = ` -Format yaml configuration files. +[Alpha] Format yaml configuration files. Fmt will format input by ordering fields and unordered list items in Kubernetes objects. Inputs may be directories, files or stdin, and their contents must @@ -72,9 +72,9 @@ var FmtExamples = ` # format kustomize output kustomize build | kyaml fmt` -var GrepShort = `Search for matching Resources in a directory or from stdin` +var GrepShort = `[Alpha] Search for matching Resources in a directory or from stdin` var GrepLong = ` - Search for matching Resources in a directory or from stdin. +[Alpha] Search for matching Resources in a directory or from stdin. QUERY: Query to match expressed as 'path.to.field=value'. @@ -99,9 +99,9 @@ var GrepExamples = ` # look for Resources matching a specific container image kyaml grep "spec.template.spec.containers[name=nginx].image=nginx:1\.7\.9" my-dir/ | kyaml tree` -var MergeShort = `Merge Resource configuration files` +var MergeShort = `[Alpha] Merge Resource configuration files` var MergeLong = ` -Merge Resource configuration files +[Alpha] Merge Resource configuration files Merge reads Kubernetes Resource yaml configuration files from stdin or sources packages and write the result to stdout or a destination package. @@ -119,9 +119,9 @@ For information on merge rules, run: var MergeExamples = ` cat resources_and_patches.yaml | kyaml merge > merged_resources.yaml` -var RunFnsShort = `Apply config functions to Resources.` +var RunFnsShort = `[Alpha] Reoncile config functions to Resources.` var RunFnsLong = ` -Apply config functions to Resources. +[Alpha] Reconcile config functions to Resources. run-fns sequentially invokes all config functions in the directly, providing Resources in the directory as input to the first function, and writing the output of the last @@ -168,9 +168,9 @@ order they appear in the file). var RunFnsExamples = ` kyaml run-fns example/` -var TreeShort = `Display Resource structure from a directory or stdin.` +var TreeShort = `[Alpha] Display Resource structure from a directory or stdin.` var TreeLong = ` -Display Resource structure from a directory or stdin. +[Alpha] Display Resource structure from a directory or stdin. kyaml tree may be used to print Resources in a directory or cluster, preserving structure diff --git a/cmd/config/cmds/cmds.go b/cmd/config/cmds/cmds.go index 78235b8f7..cd19cef53 100644 --- a/cmd/config/cmds/cmds.go +++ b/cmd/config/cmds/cmds.go @@ -15,8 +15,8 @@ import ( var root = &cobra.Command{ Use: "config", - Short: "Utilities for working with Resource Configuration.", - Long: `Utilities for working with Resource Configuration.`, + Short: "[Alpha] Utilities for working with Resource Configuration.", + Long: `[Alpha] Utilities for working with Resource Configuration.`, Version: "v0.0.1", } @@ -44,22 +44,22 @@ func NewConfigCommand(name string) *cobra.Command { root.AddCommand(&cobra.Command{ Use: "docs-merge", - Short: "Documentation for merging Resources (2-way merge).", + Short: "[Alpha] Documentation for merging Resources (2-way merge).", Long: api.Merge2Long, }) root.AddCommand(&cobra.Command{ Use: "docs-merge3", - Short: "Documentation for merging Resources (3-way merge).", + Short: "[Alpha] Documentation for merging Resources (3-way merge).", Long: api.Merge3Long, }) root.AddCommand(&cobra.Command{ Use: "docs-fn", - Short: "Documentation for writing containerized functions run by run-fns.", + Short: "[Alpha] Documentation for writing containerized functions run by run-fns.", Long: api.ConfigFnLong, }) root.AddCommand(&cobra.Command{ Use: "docs-io-annotations", - Short: "Documentation for annotations used by io.", + Short: "[Alpha] Documentation for annotations used by io.", Long: api.ConfigIoLong, }) return root diff --git a/cmd/config/docs/commands/cat.md b/cmd/config/docs/commands/cat.md index 49bb7b245..08e7b8c2d 100644 --- a/cmd/config/docs/commands/cat.md +++ b/cmd/config/docs/commands/cat.md @@ -1,10 +1,10 @@ ## cat -Print Resource Config from a local directory. +[Alpha] Print Resource Config from a local directory. ### Synopsis -Print Resource Config from a local directory. +[Alpha] Print Resource Config from a local directory. DIR: Path to local directory. diff --git a/cmd/config/docs/commands/count.md b/cmd/config/docs/commands/count.md index a537c1a52..70be322bc 100644 --- a/cmd/config/docs/commands/count.md +++ b/cmd/config/docs/commands/count.md @@ -1,10 +1,10 @@ ## count -Count Resources Config from a local directory. +[Alpha] Count Resources Config from a local directory. ### Synopsis -Count Resources Config from a local directory. +[Alpha] Count Resources Config from a local directory. DIR: Path to local directory. diff --git a/cmd/config/docs/commands/fmt.md b/cmd/config/docs/commands/fmt.md index 1539c2da5..5c7509e66 100644 --- a/cmd/config/docs/commands/fmt.md +++ b/cmd/config/docs/commands/fmt.md @@ -1,10 +1,10 @@ ## fmt -Format yaml configuration files. +[Alpha] Format yaml configuration files. ### Synopsis -Format yaml configuration files. +[Alpha] Format yaml configuration files. Fmt will format input by ordering fields and unordered list items in Kubernetes objects. Inputs may be directories, files or stdin, and their contents must diff --git a/cmd/config/docs/commands/grep.md b/cmd/config/docs/commands/grep.md index e21655567..8b4a8c17a 100644 --- a/cmd/config/docs/commands/grep.md +++ b/cmd/config/docs/commands/grep.md @@ -1,10 +1,10 @@ ## grep -Search for matching Resources in a directory or from stdin +[Alpha] Search for matching Resources in a directory or from stdin ### Synopsis - Search for matching Resources in a directory or from stdin. +[Alpha] Search for matching Resources in a directory or from stdin. QUERY: Query to match expressed as 'path.to.field=value'. diff --git a/cmd/config/docs/commands/merge.md b/cmd/config/docs/commands/merge.md index 84f0f68df..eae88650c 100644 --- a/cmd/config/docs/commands/merge.md +++ b/cmd/config/docs/commands/merge.md @@ -1,10 +1,10 @@ ## merge -Merge Resource configuration files +[Alpha] Merge Resource configuration files ### Synopsis -Merge Resource configuration files +[Alpha] Merge Resource configuration files Merge reads Kubernetes Resource yaml configuration files from stdin or sources packages and write the result to stdout or a destination package. diff --git a/cmd/config/docs/commands/run-fns.md b/cmd/config/docs/commands/run-fns.md index 1d40105f0..d4b66ec28 100644 --- a/cmd/config/docs/commands/run-fns.md +++ b/cmd/config/docs/commands/run-fns.md @@ -1,10 +1,10 @@ ## run-fns -Apply config functions to Resources. +[Alpha] Reoncile config functions to Resources. ### Synopsis -Apply config functions to Resources. +[Alpha] Reconcile config functions to Resources. run-fns sequentially invokes all config functions in the directly, providing Resources in the directory as input to the first function, and writing the output of the last diff --git a/cmd/config/docs/commands/tree.md b/cmd/config/docs/commands/tree.md index e64d1f08f..adb261166 100644 --- a/cmd/config/docs/commands/tree.md +++ b/cmd/config/docs/commands/tree.md @@ -1,10 +1,10 @@ ## tree -Display Resource structure from a directory or stdin. +[Alpha] Display Resource structure from a directory or stdin. ### Synopsis -Display Resource structure from a directory or stdin. +[Alpha] Display Resource structure from a directory or stdin. kyaml tree may be used to print Resources in a directory or cluster, preserving structure