Skip to content

Add better documentation for region and cloud provider flags #458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
laniehei wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add better documentation for region and cloud provider flags #458

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions app/namespace.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,7 +515,7 @@ func NewNamespaceCommand(getNamespaceClientFn GetNamespaceClientFn) (CommandOut,
},
&cli.StringSliceFlag{
Name: namespaceRegionFlagName,
Usage: "Create namespace in specified regions; if multiple regions are selected, the first one will be the active region. See 'tcld account list-regions' to get a list of available regions for your account",
Usage: "Create namespace in specified regions; if two regions are entered, the first one will be the active region. See 'tcld account list-regions' to get a list of available regions for your account. Regions should be in the format of 'aws-us-east-1' or 'gcp-us-central1' with the cloud provider prefix before the region name.",
Copy link

@meiliang86 meiliang86 Jul 3, 2025

Choose a reason for hiding this comment

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

nit: can you change "two" to "more than one"

Aliases: []string{"re"},
Required: true,
},
Expand Down Expand Up @@ -565,9 +565,9 @@ func NewNamespaceCommand(getNamespaceClientFn GetNamespaceClientFn) (CommandOut,
codecIncludeCredentialsFlag,
&cli.StringFlag{
Name: cloudProviderFlagName,
Usage: `Cloud provider for the namespace to be created for, currently support [aws, gcp]. For this version, if not specified, we default to aws`,
Usage: `Cloud provider for the namespace to be created for, currently support [aws, gcp]. If cloud provider not prefixed for region flag, this flag is used. If neither are provided, we default to aws`,
Aliases: []string{"cp"},
// this is a temporary solution, we will have a follow up version update to make the cloud provider mandatory
// this is a temporary solution.
Value: CloudProviderAWS,
},
},
Expand Down