From 1d4a275a4913ef155a00def4f7c438b79023370e Mon Sep 17 00:00:00 2001 From: CecileRobertMichon Date: Thu, 3 May 2018 16:21:03 -0700 Subject: [PATCH 1/2] fix formatting in cmd --- cmd/deploy.go | 4 ++-- cmd/orchestrators.go | 4 ++-- cmd/scale.go | 4 ++-- cmd/upgrade.go | 4 ++-- docs/acsengine.md | 10 +++++----- docs/acsengine.zh-CN.md | 12 ++++++++---- 6 files changed, 21 insertions(+), 17 deletions(-) diff --git a/cmd/deploy.go b/cmd/deploy.go index 1493bf563b..02c3e2f03a 100644 --- a/cmd/deploy.go +++ b/cmd/deploy.go @@ -25,8 +25,8 @@ import ( const ( deployName = "deploy" - deployShortDescription = "deploy an Azure Resource Manager template" - deployLongDescription = "deploys an Azure Resource Manager template, parameters file and other assets for a cluster" + deployShortDescription = "Deploy an Azure Resource Manager template" + deployLongDescription = "Deploys an Azure Resource Manager template, parameters file and other assets for a cluster" ) type deployCmd struct { diff --git a/cmd/orchestrators.go b/cmd/orchestrators.go index 24b82801c6..bce5a4169d 100644 --- a/cmd/orchestrators.go +++ b/cmd/orchestrators.go @@ -10,8 +10,8 @@ import ( const ( cmdName = "orchestrators" - cmdShortDescription = "provide info about supported orchestrators" - cmdLongDescription = "provide info about versions of supported orchestrators" + cmdShortDescription = "Display info about supported orchestrators" + cmdLongDescription = "Display supported versions and upgrade versions for each orchestrator" ) type orchestratorsCmd struct { diff --git a/cmd/scale.go b/cmd/scale.go index f8a9c48d6a..f8bb9a9034 100644 --- a/cmd/scale.go +++ b/cmd/scale.go @@ -51,8 +51,8 @@ type scaleCmd struct { const ( scaleName = "scale" - scaleShortDescription = "scale a deployed cluster" - scaleLongDescription = "scale a deployed cluster" + scaleShortDescription = "Scale an existing Kubernetes cluster" + scaleLongDescription = "Scale an existing Kubernetes cluster by specifying increasing or decreasing the node count of an agentpool" ) // NewScaleCmd run a command to upgrade a Kubernetes cluster diff --git a/cmd/upgrade.go b/cmd/upgrade.go index 62c211f5d5..d66fdca2ed 100644 --- a/cmd/upgrade.go +++ b/cmd/upgrade.go @@ -22,8 +22,8 @@ import ( const ( upgradeName = "upgrade" - upgradeShortDescription = "upgrades an existing Kubernetes cluster" - upgradeLongDescription = "upgrades an existing Kubernetes cluster, first replacing masters, then nodes" + upgradeShortDescription = "Upgrade an existing Kubernetes cluster" + upgradeLongDescription = "Upgrade an existing Kubernetes cluster, one minor version at a time" ) type upgradeCmd struct { diff --git a/docs/acsengine.md b/docs/acsengine.md index bbdf5b5c13..3617cb3731 100644 --- a/docs/acsengine.md +++ b/docs/acsengine.md @@ -97,18 +97,18 @@ The build process leaves the compiled `acs-engine` binary in the `bin` directory ``` # ./bin/acs-engine -ACS-Engine deploys and manages Kubernetes, Swarm Mode, and DC/OS clusters in Azure +ACS-Engine deploys and manages Kubernetes, OpenShift, Swarm Mode, and DC/OS clusters in Azure Usage: acs-engine [command] Available Commands: - deploy deploy an Azure Resource Manager template + deploy Deploy an Azure Resource Manager template generate Generate an Azure Resource Manager template help Help about any command - orchestrators provide info about supported orchestrators - scale scale a deployed cluster - upgrade upgrades an existing Kubernetes cluster + orchestrators Display info about supported orchestrators + scale Scale an existing Kubernetes cluster + upgrade Upgrade an existing Kubernetes cluster version Print the version of ACS-Engine Flags: diff --git a/docs/acsengine.zh-CN.md b/docs/acsengine.zh-CN.md index 7480908d1a..4046dd08b4 100644 --- a/docs/acsengine.zh-CN.md +++ b/docs/acsengine.zh-CN.md @@ -25,15 +25,19 @@ make build ``` # ./bin/acs-engine -ACS-Engine deploys and manages Kubernetes, Swarm Mode, and DC/OS clusters in Azure +ACS-Engine deploys and manages Kubernetes, OpenShift, Swarm Mode, and DC/OS clusters in Azure Usage: acs-engine [command] Available Commands: - generate Generate an Azure Resource Manager template - help Help about any command - version Print the version of ACS-Engine + deploy Deploy an Azure Resource Manager template + generate Generate an Azure Resource Manager template + help Help about any command + orchestrators Display info about supported orchestrators + scale Scale an existing Kubernetes cluster + upgrade Upgrade an existing Kubernetes cluster + version Print the version of ACS-Engine Flags: --debug enable verbose debug logs From 4bb2b28acc334c6122e5e3b5155ea90e81e6ebee Mon Sep 17 00:00:00 2001 From: CecileRobertMichon Date: Thu, 3 May 2018 17:42:16 -0700 Subject: [PATCH 2/2] remove s --- cmd/deploy.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/deploy.go b/cmd/deploy.go index 02c3e2f03a..735da47d47 100644 --- a/cmd/deploy.go +++ b/cmd/deploy.go @@ -26,7 +26,7 @@ import ( const ( deployName = "deploy" deployShortDescription = "Deploy an Azure Resource Manager template" - deployLongDescription = "Deploys an Azure Resource Manager template, parameters file and other assets for a cluster" + deployLongDescription = "Deploy an Azure Resource Manager template, parameters file and other assets for a cluster" ) type deployCmd struct {