Skip to content
This repository has been archived by the owner on Jan 11, 2023. It is now read-only.

Reword cmd descriptions #2856

Merged
merged 2 commits into from
May 4, 2018
Merged

Reword cmd descriptions #2856

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d4a275
fix formatting in cmd
May 3, 2018
4bb2b28
remove s
May 4, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cmd/deploy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
4 changes: 2 additions & 2 deletions cmd/orchestrators.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
4 changes: 2 additions & 2 deletions cmd/scale.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions cmd/upgrade.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
10 changes: 5 additions & 5 deletions docs/acsengine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This wasn't added in this PR, just reflects the current state of the acs-engine command (only changed docs to match output of command)


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:
Expand Down
12 changes: 8 additions & 4 deletions docs/acsengine.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down