From a5c050000dec8806e69a97a6750e945cf6739e65 Mon Sep 17 00:00:00 2001 From: "jakub.coufal" Date: Thu, 29 Mar 2018 14:10:57 +0200 Subject: [PATCH] Documentation update --- docs/config_init.md | 33 ------------------- docs/{config.md => scccmd.md} | 14 ++++---- docs/{config_decrypt.md => scccmd_decrypt.md} | 6 ++-- docs/{config_encrypt.md => scccmd_encrypt.md} | 6 ++-- docs/{config_gendoc.md => scccmd_gendoc.md} | 6 ++-- docs/{config_get.md => scccmd_get.md} | 8 ++--- ...onfig_get_files.md => scccmd_get_files.md} | 6 ++-- ...fig_get_values.md => scccmd_get_values.md} | 6 ++-- ...g_initializer.md => scccmd_initializer.md} | 6 ++-- 9 files changed, 29 insertions(+), 62 deletions(-) delete mode 100644 docs/config_init.md rename docs/{config.md => scccmd.md} (54%) rename docs/{config_decrypt.md => scccmd_decrypt.md} (80%) rename docs/{config_encrypt.md => scccmd_encrypt.md} (80%) rename docs/{config_gendoc.md => scccmd_gendoc.md} (78%) rename docs/{config_get.md => scccmd_get.md} (75%) rename docs/{config_get_files.md => scccmd_get_files.md} (86%) rename docs/{config_get_values.md => scccmd_get_values.md} (87%) rename docs/{config_initializer.md => scccmd_initializer.md} (88%) diff --git a/docs/config_init.md b/docs/config_init.md deleted file mode 100644 index f77b3eb..0000000 --- a/docs/config_init.md +++ /dev/null @@ -1,33 +0,0 @@ -## config init - -Initialize the config from the given config server - -### Synopsis - - -Initialize the config from the given config server - -``` -config init [flags] -``` - -### Options - -``` - -a, --application string name of the application to get the config for - -f, --files fileMappings files to get in form of source:destination pairs, example '--files application.yaml:config.yaml' - -h, --help help for init - -l, --label string configuration label (default "master") - -p, --profile string configuration profile (default "default") - -s, --source string address of the config server -``` - -### Options inherited from parent commands - -``` - -v, --verbose verbose output -``` - -### SEE ALSO -* [config](config.md) - Spring Cloud Config management tool - diff --git a/docs/config.md b/docs/scccmd.md similarity index 54% rename from docs/config.md rename to docs/scccmd.md index 3daeffa..10c2d4d 100644 --- a/docs/config.md +++ b/docs/scccmd.md @@ -1,4 +1,4 @@ -## config +## scccmd Spring Cloud Config management tool @@ -11,14 +11,14 @@ Tool currently provides functionality t get (download) config file from server. ### Options ``` - -h, --help help for config + -h, --help help for scccmd -v, --verbose verbose output ``` ### SEE ALSO -* [config decrypt](config_decrypt.md) - Decrypt the value server-side and prints the response -* [config encrypt](config_encrypt.md) - Encrypt the value server-side and prints the response -* [config gendoc](config_gendoc.md) - Generates documentation for this tool in Markdown format -* [config get](config_get.md) - Get the config from the given config server -* [config initializer](config_initializer.md) - Runs K8s initializer for injecting config from Cloud Config Server +* [scccmd decrypt](scccmd_decrypt.md) - Decrypt the value server-side and prints the response +* [scccmd encrypt](scccmd_encrypt.md) - Encrypt the value server-side and prints the response +* [scccmd gendoc](scccmd_gendoc.md) - Generates documentation for this tool in Markdown format +* [scccmd get](scccmd_get.md) - Get the config from the given config server +* [scccmd initializer](scccmd_initializer.md) - Runs K8s initializer for injecting config from Cloud Config Server diff --git a/docs/config_decrypt.md b/docs/scccmd_decrypt.md similarity index 80% rename from docs/config_decrypt.md rename to docs/scccmd_decrypt.md index d4b21f9..6516c1b 100644 --- a/docs/config_decrypt.md +++ b/docs/scccmd_decrypt.md @@ -1,4 +1,4 @@ -## config decrypt +## scccmd decrypt Decrypt the value server-side and prints the response @@ -8,7 +8,7 @@ Decrypt the value server-side and prints the response Decrypt the value server-side and prints the response ``` -config decrypt [flags] +scccmd decrypt [flags] ``` ### Options @@ -26,5 +26,5 @@ config decrypt [flags] ``` ### SEE ALSO -* [config](config.md) - Spring Cloud Config management tool +* [scccmd](scccmd.md) - Spring Cloud Config management tool diff --git a/docs/config_encrypt.md b/docs/scccmd_encrypt.md similarity index 80% rename from docs/config_encrypt.md rename to docs/scccmd_encrypt.md index 2d6f540..88b892e 100644 --- a/docs/config_encrypt.md +++ b/docs/scccmd_encrypt.md @@ -1,4 +1,4 @@ -## config encrypt +## scccmd encrypt Encrypt the value server-side and prints the response @@ -8,7 +8,7 @@ Encrypt the value server-side and prints the response Encrypt the value server-side and prints the response ``` -config encrypt [flags] +scccmd encrypt [flags] ``` ### Options @@ -26,5 +26,5 @@ config encrypt [flags] ``` ### SEE ALSO -* [config](config.md) - Spring Cloud Config management tool +* [scccmd](scccmd.md) - Spring Cloud Config management tool diff --git a/docs/config_gendoc.md b/docs/scccmd_gendoc.md similarity index 78% rename from docs/config_gendoc.md rename to docs/scccmd_gendoc.md index 35ea0fc..c73710f 100644 --- a/docs/config_gendoc.md +++ b/docs/scccmd_gendoc.md @@ -1,4 +1,4 @@ -## config gendoc +## scccmd gendoc Generates documentation for this tool in Markdown format @@ -8,7 +8,7 @@ Generates documentation for this tool in Markdown format Generates documentation for this tool in Markdown format ``` -config gendoc [flags] +scccmd gendoc [flags] ``` ### Options @@ -25,5 +25,5 @@ config gendoc [flags] ``` ### SEE ALSO -* [config](config.md) - Spring Cloud Config management tool +* [scccmd](scccmd.md) - Spring Cloud Config management tool diff --git a/docs/config_get.md b/docs/scccmd_get.md similarity index 75% rename from docs/config_get.md rename to docs/scccmd_get.md index 8673375..9deddf9 100644 --- a/docs/config_get.md +++ b/docs/scccmd_get.md @@ -1,4 +1,4 @@ -## config get +## scccmd get Get the config from the given config server @@ -24,7 +24,7 @@ Get the config from the given config server ``` ### SEE ALSO -* [config](config.md) - Spring Cloud Config management tool -* [config get files](config_get_files.md) - Get the config files from the given config server -* [config get values](config_get_values.md) - Get the config values in specified format from the given config server +* [scccmd](scccmd.md) - Spring Cloud Config management tool +* [scccmd get files](scccmd_get_files.md) - Get the config files from the given config server +* [scccmd get values](scccmd_get_values.md) - Get the config values in specified format from the given config server diff --git a/docs/config_get_files.md b/docs/scccmd_get_files.md similarity index 86% rename from docs/config_get_files.md rename to docs/scccmd_get_files.md index 426f19a..96804dc 100644 --- a/docs/config_get_files.md +++ b/docs/scccmd_get_files.md @@ -1,4 +1,4 @@ -## config get files +## scccmd get files Get the config files from the given config server @@ -8,7 +8,7 @@ Get the config files from the given config server Get the config files from the given config server ``` -config get files [flags] +scccmd get files [flags] ``` ### Options @@ -29,5 +29,5 @@ config get files [flags] ``` ### SEE ALSO -* [config get](config_get.md) - Get the config from the given config server +* [scccmd get](scccmd_get.md) - Get the config from the given config server diff --git a/docs/config_get_values.md b/docs/scccmd_get_values.md similarity index 87% rename from docs/config_get_values.md rename to docs/scccmd_get_values.md index 26bb4e0..ac5ae9f 100644 --- a/docs/config_get_values.md +++ b/docs/scccmd_get_values.md @@ -1,4 +1,4 @@ -## config get values +## scccmd get values Get the config values in specified format from the given config server @@ -8,7 +8,7 @@ Get the config values in specified format from the given config server Get the config values in specified format from the given config server ``` -config get values [flags] +scccmd get values [flags] ``` ### Options @@ -30,5 +30,5 @@ config get values [flags] ``` ### SEE ALSO -* [config get](config_get.md) - Get the config from the given config server +* [scccmd get](scccmd_get.md) - Get the config from the given config server diff --git a/docs/config_initializer.md b/docs/scccmd_initializer.md similarity index 88% rename from docs/config_initializer.md rename to docs/scccmd_initializer.md index f09952c..a6cc512 100644 --- a/docs/config_initializer.md +++ b/docs/scccmd_initializer.md @@ -1,4 +1,4 @@ -## config initializer +## scccmd initializer Runs K8s initializer for injecting config from Cloud Config Server @@ -8,7 +8,7 @@ Runs K8s initializer for injecting config from Cloud Config Server Runs K8s initializer for injecting config from Cloud Config Server ``` -config initializer [flags] +scccmd initializer [flags] ``` ### Options @@ -28,5 +28,5 @@ config initializer [flags] ``` ### SEE ALSO -* [config](config.md) - Spring Cloud Config management tool +* [scccmd](scccmd.md) - Spring Cloud Config management tool