updated spelling for docs generation (#320)

pkg/cmd/login/login.go

@@ -57,7 +57,7 @@ func NewCmdLogin(f factory.Factory) *cobra.Command {
 		Long:  "Login to your Octopus server using OpenID Connect (OIDC) or an API key. If no arguments are provided then login will be done interactively allowing creation of an API key.",
 		Example: heredoc.Docf(`
 			$ %[1]s login
-			$ %[1]s login --server https://my.octopus.app --service-account-id b1a6f20f-0ec7-4e9a-938e-db800f945b37 --id-token eyJhbGciOiJQUzI1NiIsImtp...
+			$ %[1]s login --server https://my.octopus.app --service-account-id b1a6f20f-0ec7-4e9a-938e-db800f945b37 --id-token eyJhbGciOiJQUzI1NiIs...
 			$ %[1]s login --server https://my.octopus.app --api-key API-APIKEY123
 		`, constants.ExecutableName),
 		RunE: func(cmd *cobra.Command, args []string) error {

pkg/cmd/project/branch/create/create.go

@@ -66,7 +66,7 @@ func NewCmdCreate(f factory.Factory) *cobra.Command {
 		Aliases: []string{"add"},
 		Example: heredoc.Docf(`
 			$ %[1]s project branch create
-			$ %[1]s project branch create --project "Deploy Website" --name branch-nane --base-branch refs/heads/main
+			$ %[1]s project branch create --project "Deploy Website" --name branch-name --base-branch refs/heads/main
 		`, constants.ExecutableName),
 		RunE: func(c *cobra.Command, args []string) error {
 			opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c))

pkg/cmd/project/variables/create/create.go

@@ -115,10 +115,10 @@ func NewCreateCmd(f factory.Factory) *cobra.Command {
 		Aliases: []string{"add"},
 		Example: heredoc.Docf(`
 			$ %[1]s project variable create
-			$ %[1]s project variable create --project "Deploy Website" --name varname --value "abc"
-			$ %[1]s project variable create --name varname --value "passwordABC" --type sensitive
-			$ %[1]s project variable create --name varname --value "abc" --scope environment='test'
-			$ %[1]s project variable create --name varname --value "abc" --scope environment='test' --git-ref refs/heads/main
+			$ %[1]s project variable create --project "Deploy Website" --name "variable name" --value "abc"
+			$ %[1]s project variable create --name "variable name" --value "passwordABC" --type sensitive
+			$ %[1]s project variable create --name "variable name" --value "abc" --scope environment='test'
+			$ %[1]s project variable create --name "variable name" --value "abc" --scope environment='test' --git-ref refs/heads/main
 		`, constants.ExecutableName),
 		RunE: func(c *cobra.Command, args []string) error {
 			opts := NewCreateOptions(createFlags, cmd.NewDependencies(f, c))

pkg/cmd/project/variables/update/update.go

@@ -81,11 +81,11 @@ func NewUpdateCmd(f factory.Factory) *cobra.Command {
 		Long:  "Update the value of a project variable in Octopus Deploy",
 		Example: heredoc.Docf(`
 			$ %[1]s project variable update
-			$ %[1]s project variable update --name varname --value "abc"
-			$ %[1]s project variable update --name varname --value "password"
-			$ %[1]s project variable update --name varname --unscoped
-			$ %[1]s project variable update --name varname --environment-scope test
-			$ %[1]s project variable update -p "Deploy Website" --name varname --value "updated" --git-ref refs/heads/main
+			$ %[1]s project variable update --name "variable name" --value "abc"
+			$ %[1]s project variable update --name "variable name" --value "password"
+			$ %[1]s project variable update --name "variable name" --unscoped
+			$ %[1]s project variable update --name "variable name" --environment-scope test
+			$ %[1]s project variable update -p "Deploy Website" --name "variable name" --value "updated" --git-ref refs/heads/main
 		`, constants.ExecutableName),
 		RunE: func(c *cobra.Command, args []string) error {
 			opts := NewUpdateOptions(updateFlags, cmd.NewDependencies(f, c))

pkg/cmd/target/kubernetes/create/create.go

@@ -299,9 +299,9 @@ func NewCmdCreate(f factory.Factory) *cobra.Command {
 	flags.StringVar(&createFlags.Certificate.Value, createFlags.Certificate.Name, "", "Name of Certificate in Octopus Deploy.")
 	flags.StringVar(&createFlags.CertificateFilePath.Value, createFlags.CertificateFilePath.Name, "", "The path to the CA certificate of the cluster. The default value usually is: /var/run/secrets/kubernetes.io/serviceaccount/ca.crt")
 
-	flags.StringVar(&createFlags.ContainerRegistry.Value, createFlags.ContainerRegistry.Name, "", "The feed of the docker container registery to use if running health check in a container on the worker")
+	flags.StringVar(&createFlags.ContainerRegistry.Value, createFlags.ContainerRegistry.Name, "", "The feed of the docker container registry to use if running health check in a container on the worker")
 
-	flags.StringVar(&createFlags.ImageFlags.Value, createFlags.ImageFlags.Name, "", "The image (including the tag) to use from the container registery")
+	flags.StringVar(&createFlags.ImageFlags.Value, createFlags.ImageFlags.Name, "", "The image (including the tag) to use from the container registry")
 
 	shared.RegisterCreateTargetEnvironmentFlags(cmd, createFlags.CreateTargetEnvironmentFlags)
 	shared.RegisterCreateTargetWorkerPoolFlags(cmd, createFlags.WorkerPoolFlags)

pkg/cmd/tenant/clone/clone.go

@@ -65,7 +65,7 @@ func NewCmdClone(f factory.Factory) *cobra.Command {
 		Long:  "Clone a tenant in Octopus Deploy",
 		Example: heredoc.Docf(`
 			$ %[1]s tenant clone
-			$ %[1]s tenant clone --name "Garys Cakes" --source-tenant "Bobs Wood Shop" 
+			$ %[1]s tenant clone --name "Gary's Cakes" --source-tenant "Bob's Wood Shop" 
 		`, constants.ExecutableName),
 		RunE: func(c *cobra.Command, args []string) error {
 			opts := NewCloneOptions(cloneFlags, cmd.NewDependencies(f, c))

pkg/cmd/tenant/variables/update/update.go

@@ -100,8 +100,8 @@ func NewCmdUpdate(f factory.Factory) *cobra.Command {
 		Long:  "Update the value of a tenant variable in Octopus Deploy",
 		Example: heredoc.Docf(`
 			$ %[1]s tenant variable update
-			$ %[1]s tenant variable update --tenant "Bobs Fish Shack" --name "site-name" --value "Bobs Fish Shack" --project "Awesome Web Site" --environment "Test"
-			$ %[1]s tenant variable update --tenant "Sallys Tackle Truck" --name dbPassword --value "12345" --library-variable-set "Shared Variables"
+			$ %[1]s tenant variable update --tenant "Bobs Fish Shack" --name "site-name" --value "Bob's Fish Shack" --project "Awesome Web Site" --environment "Test"
+			$ %[1]s tenant variable update --tenant "Sally's Tackle Truck" --name dbPassword --value "12345" --library-variable-set "Shared Variables"
 			`, constants.ExecutableName),
 		RunE: func(c *cobra.Command, args []string) error {
 			opts := NewUpdateOptions(updateFlags, cmd.NewDependencies(f, c))

pkg/cmd/user/delete/delete.go

@@ -30,7 +30,7 @@ func NewCmdDelete(f factory.Factory) *cobra.Command {
 		Long:    "Delete a user in Octopus Deploy",
 		Aliases: []string{"del", "rm", "remove"},
 		Example: heredoc.Docf(`
-			$ %[1]s user delete someusername
+			$ %[1]s user delete some-user-name
 			$ %[1]s user rm Users-123
 		`, constants.ExecutableName),
 		RunE: func(c *cobra.Command, args []string) error {