mirror of
https://github.com/edgelesssys/constellation.git
synced 2024-12-23 14:39:40 -05:00
lowercase short descriptions
This commit is contained in:
parent
67c20c606c
commit
499dc3577a
@ -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,
|
||||
}
|
||||
|
@ -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),
|
||||
}
|
||||
|
@ -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),
|
||||
|
@ -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),
|
||||
|
@ -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,
|
||||
|
@ -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,
|
||||
|
@ -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),
|
||||
}
|
||||
|
@ -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,
|
||||
|
@ -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,
|
||||
|
@ -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,
|
||||
|
@ -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),
|
||||
|
@ -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),
|
||||
}
|
||||
|
@ -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,
|
||||
|
@ -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),
|
||||
|
@ -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),
|
||||
|
@ -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,
|
||||
|
@ -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),
|
||||
}
|
||||
|
@ -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,
|
||||
|
@ -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,
|
||||
|
@ -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 + "`.",
|
||||
|
@ -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,
|
||||
|
@ -173,7 +173,7 @@ and `<Title>` 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.
|
||||
|
Loading…
Reference in New Issue
Block a user