From 499dc3577a0b16859027e0fba88dc22a4774223b Mon Sep 17 00:00:00 2001 From: stdoutput Date: Tue, 17 Jan 2023 12:28:00 +0100 Subject: [PATCH] lowercase short descriptions --- cli/cmd/root.go | 2 +- cli/internal/cmd/config.go | 2 +- cli/internal/cmd/configfetchmeasurements.go | 2 +- cli/internal/cmd/configgenerate.go | 2 +- cli/internal/cmd/configinstancetypes.go | 2 +- cli/internal/cmd/create.go | 2 +- cli/internal/cmd/iam.go | 4 ++-- cli/internal/cmd/iamcreateaws.go | 2 +- cli/internal/cmd/iamcreateazure.go | 2 +- cli/internal/cmd/iamcreategcp.go | 2 +- cli/internal/cmd/init.go | 2 +- cli/internal/cmd/mini.go | 2 +- cli/internal/cmd/minidown.go | 2 +- cli/internal/cmd/miniup.go | 2 +- cli/internal/cmd/recover.go | 2 +- cli/internal/cmd/terminate.go | 2 +- cli/internal/cmd/upgrade.go | 2 +- cli/internal/cmd/upgradeexecute.go | 2 +- cli/internal/cmd/upgradeplan.go | 2 +- cli/internal/cmd/verify.go | 2 +- cli/internal/cmd/version.go | 2 +- dev-docs/conventions.md | 2 +- 22 files changed, 23 insertions(+), 23 deletions(-) diff --git a/cli/cmd/root.go b/cli/cmd/root.go index 76914240d..8152f6d55 100644 --- a/cli/cmd/root.go +++ b/cli/cmd/root.go @@ -30,7 +30,7 @@ func Execute() error { func NewRootCmd() *cobra.Command { rootCmd := &cobra.Command{ Use: "constellation", - Short: "Manage your Constellation cluster", + Short: "manage your Constellation cluster", Long: "Manage your Constellation cluster.", PersistentPreRun: preRunRoot, } diff --git a/cli/internal/cmd/config.go b/cli/internal/cmd/config.go index b68cb9e67..4417a7d02 100644 --- a/cli/internal/cmd/config.go +++ b/cli/internal/cmd/config.go @@ -15,7 +15,7 @@ import ( func NewConfigCmd() *cobra.Command { cmd := &cobra.Command{ Use: "config", - Short: "Work with the Constellation configuration file", + Short: "work with the Constellation configuration file", Long: "Work with the Constellation configuration file.", Args: cobra.ExactArgs(0), } diff --git a/cli/internal/cmd/configfetchmeasurements.go b/cli/internal/cmd/configfetchmeasurements.go index e2ef071f9..091773677 100644 --- a/cli/internal/cmd/configfetchmeasurements.go +++ b/cli/internal/cmd/configfetchmeasurements.go @@ -29,7 +29,7 @@ import ( func newConfigFetchMeasurementsCmd() *cobra.Command { cmd := &cobra.Command{ Use: "fetch-measurements", - Short: "Fetch measurements for configured cloud provider and image", + Short: "fetch measurements for configured cloud provider and image", Long: "Fetch measurements for configured cloud provider and image.\n" + "A config needs to be generated first.", Args: cobra.ExactArgs(0), diff --git a/cli/internal/cmd/configgenerate.go b/cli/internal/cmd/configgenerate.go index 38b286609..ad6701190 100644 --- a/cli/internal/cmd/configgenerate.go +++ b/cli/internal/cmd/configgenerate.go @@ -21,7 +21,7 @@ import ( func newConfigGenerateCmd() *cobra.Command { cmd := &cobra.Command{ Use: "generate {aws|azure|gcp|qemu}", - Short: "Generate a default configuration file", + Short: "generate a default configuration file", Long: "Generate a default configuration file for your selected cloud provider.", Args: cobra.MatchAll( cobra.ExactArgs(1), diff --git a/cli/internal/cmd/configinstancetypes.go b/cli/internal/cmd/configinstancetypes.go index 52161cf3b..153af9438 100644 --- a/cli/internal/cmd/configinstancetypes.go +++ b/cli/internal/cmd/configinstancetypes.go @@ -16,7 +16,7 @@ import ( func newConfigInstanceTypesCmd() *cobra.Command { cmd := &cobra.Command{ Use: "instance-types", - Short: "Print the supported instance types for all cloud providers", + Short: "print the supported instance types for all cloud providers", Long: "Print the supported instance types for all cloud providers.", Args: cobra.ArbitraryArgs, Run: printSupportedInstanceTypes, diff --git a/cli/internal/cmd/create.go b/cli/internal/cmd/create.go index e6d0e94d4..0acd2a334 100644 --- a/cli/internal/cmd/create.go +++ b/cli/internal/cmd/create.go @@ -25,7 +25,7 @@ import ( func NewCreateCmd() *cobra.Command { cmd := &cobra.Command{ Use: "create", - Short: "Create instances on a cloud platform for your Constellation cluster", + Short: "create instances on a cloud platform for your Constellation cluster", Long: "Create instances on a cloud platform for your Constellation cluster.", Args: cobra.ExactArgs(0), RunE: runCreate, diff --git a/cli/internal/cmd/iam.go b/cli/internal/cmd/iam.go index c051546fd..099916cb0 100644 --- a/cli/internal/cmd/iam.go +++ b/cli/internal/cmd/iam.go @@ -13,7 +13,7 @@ import ( func NewIAMCmd() *cobra.Command { cmd := &cobra.Command{ Use: "iam", - Short: "Work with the IAM configuration on your cloud provider", + Short: "work with the IAM configuration on your cloud provider", Long: "Work with the IAM configuration on your cloud provider.", Args: cobra.ExactArgs(0), } @@ -27,7 +27,7 @@ func NewIAMCmd() *cobra.Command { func newIAMCreateCmd() *cobra.Command { cmd := &cobra.Command{ Use: "create", - Short: "Create IAM configuration on a cloud platform for your Constellation cluster", + Short: "create IAM configuration on a cloud platform for your Constellation cluster", Long: "Create IAM configuration on a cloud platform for your Constellation cluster.", Args: cobra.ExactArgs(0), } diff --git a/cli/internal/cmd/iamcreateaws.go b/cli/internal/cmd/iamcreateaws.go index adea2612e..52194ec2d 100644 --- a/cli/internal/cmd/iamcreateaws.go +++ b/cli/internal/cmd/iamcreateaws.go @@ -20,7 +20,7 @@ import ( func newIAMCreateAWSCmd() *cobra.Command { cmd := &cobra.Command{ Use: "aws", - Short: "Create IAM configuration on AWS for your Constellation cluster", + Short: "create IAM configuration on AWS for your Constellation cluster", Long: "Create IAM configuration on AWS for your Constellation cluster.", Args: cobra.ExactArgs(0), RunE: runIAMCreateAWS, diff --git a/cli/internal/cmd/iamcreateazure.go b/cli/internal/cmd/iamcreateazure.go index ec84b6c3c..d849faeff 100644 --- a/cli/internal/cmd/iamcreateazure.go +++ b/cli/internal/cmd/iamcreateazure.go @@ -19,7 +19,7 @@ import ( func newIAMCreateAzureCmd() *cobra.Command { cmd := &cobra.Command{ Use: "azure", - Short: "Create IAM configuration on Microsoft Azure for your Constellation cluster", + Short: "create IAM configuration on Microsoft Azure for your Constellation cluster", Long: "Create IAM configuration on Microsoft Azure for your Constellation cluster.", Args: cobra.ExactArgs(0), RunE: runIAMCreateAzure, diff --git a/cli/internal/cmd/iamcreategcp.go b/cli/internal/cmd/iamcreategcp.go index 9f6c8f726..505c44698 100644 --- a/cli/internal/cmd/iamcreategcp.go +++ b/cli/internal/cmd/iamcreategcp.go @@ -31,7 +31,7 @@ var ( func newIAMCreateGCPCmd() *cobra.Command { cmd := &cobra.Command{ Use: "gcp", - Short: "Create IAM configuration on GCP for your Constellation cluster", + Short: "create IAM configuration on GCP for your Constellation cluster", Long: "Create IAM configuration on GCP for your Constellation cluster.", Args: cobra.ExactArgs(0), RunE: runIAMCreateGCP, diff --git a/cli/internal/cmd/init.go b/cli/internal/cmd/init.go index 21c6752d9..2b1fe9d83 100644 --- a/cli/internal/cmd/init.go +++ b/cli/internal/cmd/init.go @@ -43,7 +43,7 @@ import ( func NewInitCmd() *cobra.Command { cmd := &cobra.Command{ Use: "init", - Short: "Initialize the Constellation cluster", + Short: "initialize the Constellation cluster", Long: "Initialize the Constellation cluster.\n" + "Start your confidential Kubernetes.", Args: cobra.ExactArgs(0), diff --git a/cli/internal/cmd/mini.go b/cli/internal/cmd/mini.go index 4b4774f67..6077cd7b5 100644 --- a/cli/internal/cmd/mini.go +++ b/cli/internal/cmd/mini.go @@ -12,7 +12,7 @@ import "github.com/spf13/cobra" func NewMiniCmd() *cobra.Command { cmd := &cobra.Command{ Use: "mini", - Short: "Manage MiniConstellation clusters", + Short: "manage MiniConstellation clusters", Long: "Manage MiniConstellation clusters.", Args: cobra.ExactArgs(0), } diff --git a/cli/internal/cmd/minidown.go b/cli/internal/cmd/minidown.go index aa5c798a9..7fe180fd4 100644 --- a/cli/internal/cmd/minidown.go +++ b/cli/internal/cmd/minidown.go @@ -23,7 +23,7 @@ import ( func newMiniDownCmd() *cobra.Command { cmd := &cobra.Command{ Use: "down", - Short: "Destroy a MiniConstellation cluster", + Short: "destroy a MiniConstellation cluster", Long: "Destroy a MiniConstellation cluster.", Args: cobra.ExactArgs(0), RunE: runDown, diff --git a/cli/internal/cmd/miniup.go b/cli/internal/cmd/miniup.go index 585987c92..f46bf033b 100644 --- a/cli/internal/cmd/miniup.go +++ b/cli/internal/cmd/miniup.go @@ -33,7 +33,7 @@ import ( func newMiniUpCmd() *cobra.Command { cmd := &cobra.Command{ Use: "up", - Short: "Create and initialize a new MiniConstellation cluster", + Short: "create and initialize a new MiniConstellation cluster", Long: "Create and initialize a new MiniConstellation cluster.\n" + "A mini cluster consists of a single control-plane and worker node, hosted using QEMU/KVM.", Args: cobra.ExactArgs(0), diff --git a/cli/internal/cmd/recover.go b/cli/internal/cmd/recover.go index 5fb200706..a490ef38f 100644 --- a/cli/internal/cmd/recover.go +++ b/cli/internal/cmd/recover.go @@ -34,7 +34,7 @@ import ( func NewRecoverCmd() *cobra.Command { cmd := &cobra.Command{ Use: "recover", - Short: "Recover a completely stopped Constellation cluster", + Short: "recover a completely stopped Constellation cluster", Long: "Recover a Constellation cluster by sending a recovery key to an instance in the boot stage.\n" + "This is only required if instances restart without other instances available for bootstrapping.", Args: cobra.ExactArgs(0), diff --git a/cli/internal/cmd/terminate.go b/cli/internal/cmd/terminate.go index 8cffe3246..65a48d742 100644 --- a/cli/internal/cmd/terminate.go +++ b/cli/internal/cmd/terminate.go @@ -24,7 +24,7 @@ import ( func NewTerminateCmd() *cobra.Command { cmd := &cobra.Command{ Use: "terminate", - Short: "Terminate a Constellation cluster", + Short: "terminate a Constellation cluster", Long: "Terminate a Constellation cluster.\n" + "The cluster can't be started again, and all persistent storage will be lost.", Args: cobra.NoArgs, diff --git a/cli/internal/cmd/upgrade.go b/cli/internal/cmd/upgrade.go index 14cd39208..3e8c53d95 100644 --- a/cli/internal/cmd/upgrade.go +++ b/cli/internal/cmd/upgrade.go @@ -14,7 +14,7 @@ import ( func NewUpgradeCmd() *cobra.Command { cmd := &cobra.Command{ Use: "upgrade", - Short: "Plan and perform an upgrade of a Constellation cluster", + Short: "plan and perform an upgrade of a Constellation cluster", Long: "Plan and perform an upgrade of a Constellation cluster.", Args: cobra.ExactArgs(0), } diff --git a/cli/internal/cmd/upgradeexecute.go b/cli/internal/cmd/upgradeexecute.go index 0f6343806..ca9cdfab5 100644 --- a/cli/internal/cmd/upgradeexecute.go +++ b/cli/internal/cmd/upgradeexecute.go @@ -25,7 +25,7 @@ import ( func newUpgradeExecuteCmd() *cobra.Command { cmd := &cobra.Command{ Use: "execute", - Short: "Execute an upgrade of a Constellation cluster", + Short: "execute an upgrade of a Constellation cluster", Long: "Execute an upgrade of a Constellation cluster by applying the chosen configuration.", Args: cobra.NoArgs, RunE: runUpgradeExecute, diff --git a/cli/internal/cmd/upgradeplan.go b/cli/internal/cmd/upgradeplan.go index 92c7e0783..3801bf6ad 100644 --- a/cli/internal/cmd/upgradeplan.go +++ b/cli/internal/cmd/upgradeplan.go @@ -33,7 +33,7 @@ import ( func newUpgradePlanCmd() *cobra.Command { cmd := &cobra.Command{ Use: "plan", - Short: "Plan an upgrade of a Constellation cluster", + Short: "plan an upgrade of a Constellation cluster", Long: "Plan an upgrade of a Constellation cluster by fetching compatible image versions and their measurements.", Args: cobra.NoArgs, RunE: runUpgradePlan, diff --git a/cli/internal/cmd/verify.go b/cli/internal/cmd/verify.go index 5ca98d328..16c558d31 100644 --- a/cli/internal/cmd/verify.go +++ b/cli/internal/cmd/verify.go @@ -34,7 +34,7 @@ import ( func NewVerifyCmd() *cobra.Command { cmd := &cobra.Command{ Use: "verify", - Short: "Verify the confidential properties of a Constellation cluster", + Short: "verify the confidential properties of a Constellation cluster", Long: `Verify the confidential properties of a Constellation cluster. If arguments aren't specified, values are read from ` + "`" + constants.ClusterIDsFileName + "`.", diff --git a/cli/internal/cmd/version.go b/cli/internal/cmd/version.go index 83dffa261..04454af19 100644 --- a/cli/internal/cmd/version.go +++ b/cli/internal/cmd/version.go @@ -17,7 +17,7 @@ import ( func NewVersionCmd() *cobra.Command { cmd := &cobra.Command{ Use: "version", - Short: "Display version of this CLI", + Short: "display version of this CLI", Long: "Display version of this CLI.", Args: cobra.NoArgs, Run: runVersion, diff --git a/dev-docs/conventions.md b/dev-docs/conventions.md index f8b6c1705..c73635fb5 100644 --- a/dev-docs/conventions.md +++ b/dev-docs/conventions.md @@ -173,7 +173,7 @@ and `` starts with a capital letter. The command reference within the CLI should follow the following conventions: -- Short description: Starts with a capital letter, beginnings of sentences, names and acronyms are capitalized, ends without a period. It should be a single sentence. +- Short description: Starts with a lowercase letter, beginnings of sentences, names and acronyms are capitalized, ends without a period. It should be a single sentence. - Long description: Starts with a capital letter, beginnings of sentences, names and acronyms are capitalized, ends with a period. - If the long description contains multiple sentences, the first sentence is formatted as a long description, followed by a newline and the rest of the sentences. The rest of the sentences start with a capital letter, beginnings of sentences, names and acronyms are capitalized and each sentence ends with a period. - Flag: Starts with a lowercase letter, beginnings of sentences, names and acronyms are capitalized, ends without a period.