Changes to 'use' in cmd folder (flyteorg#235)

* Update nouns.rst * removed html links Created separate rst file for each noun and referenced it in the nouns.rst file. * Update verbs.rst * Deleted newly added rst files error with codecov, so deleted the newly added rst files. * Delete verbs.rst * Created separate rst files for every resource * Changes to files in cmd folder * Update create_test.go * cmd folders * Update cmd/create/execution.go Co-authored-by: Samhita Alla <[email protected]> * Added verbs.rst * changes to cmd folder files /bin removed, * Update based on review * Update cmd/create/project.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/create/create.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/create/create_test.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/delete/delete.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/delete/matchable_cluster_resource_attribute.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/delete/matchable_task_resource_attribute.go Co-authored-by: Samhita Alla <[email protected]> * Changes to delete - matchable_plugin_override * Changes to .go files in cmd * Changed flytesnack to Flytesnack * Creates to create * Update cmd/get/launch_plan.go Co-authored-by: Samhita Alla <[email protected]> * Changed 'launchplan' to 'launch plan' * Update cmd/register/examples.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/register/examples.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/register/examples.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/register/files.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/register/register.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/register/register_test.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/sandbox/sandbox.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/sandbox/start.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/sandbox/start.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/sandbox/status.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/update/matchable_cluster_resource_attribute.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/update/matchable_cluster_resource_attribute.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/update/matchable_execution_cluster_label.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/update/matchable_execution_queue_attribute.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/update/matchable_plugin_override.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/update/matchable_task_resource_attribute.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/update/matchable_workflow_execution_config.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/update/matchable_workflow_execution_config.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/update/update.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/upgrade/upgrade.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/upgrade/upgrade.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/version/version.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/update/matchable_task_resource_attribute.go Co-authored-by: Samhita Alla <[email protected]> * Update cmd/update/update.go Co-authored-by: Samhita Alla <[email protected]> * Resolved changes * Changed 'delte' to 'delete' * Updated rst files Created rst files for every noun, and linked the associated verbs with it * Trial * Removed the extra whitespace * Changed 'delte' to 'delete' * Changed 'use' in some cmd folders * Description to rst files * Resolved conflicts Co-authored-by: Samhita Alla <[email protected]>
austin362667 · May 7, 2024 · 76f2ae9 · 76f2ae9
1 parent 59a6ce1
commit 76f2ae9
Show file tree

Hide file tree

Showing 74 changed files with 359 additions and 304 deletions.
diff --git a/flytectl/cmd/delete/matchable_workflow_execution_config_test.go b/flytectl/cmd/delete/matchable_workflow_execution_config_test.go
@@ -41,10 +41,10 @@ func TestDeleteWorkflowExecutionConfig(t *testing.T) {
 		deleteWorkflowExecutionConfigSetup()
 		// No args implying project domain attribute deletion
 		u.DeleterExt.OnDeleteProjectDomainAttributesMatch(mock.Anything, mock.Anything, mock.Anything,
-			mock.Anything).Return(fmt.Errorf("failed to delte project domain attributes"))
+			mock.Anything).Return(fmt.Errorf("failed to delete project domain attributes"))
 		err = deleteWorkflowExecutionConfig(ctx, args, cmdCtx)
 		assert.NotNil(t, err)
-		assert.Equal(t, fmt.Errorf("failed to delte project domain attributes"), err)
+		assert.Equal(t, fmt.Errorf("failed to delete project domain attributes"), err)
 		u.DeleterExt.AssertCalled(t, "DeleteProjectDomainAttributes",
 			ctx, config.GetConfig().Project, config.GetConfig().Domain, admin.MatchableResource_WORKFLOW_EXECUTION_CONFIG)
 	})

diff --git a/flytectl/cmd/get/matchable_execution_cluster_label_test.go b/flytectl/cmd/get/matchable_execution_cluster_label_test.go
@@ -92,7 +92,7 @@ func TestGetExecutionClusterLabel(t *testing.T) {
 			ctx, config.GetConfig().Project, config.GetConfig().Domain, admin.MatchableResource_EXECUTION_CLUSTER_LABEL)
 		tearDownAndVerify(t, ``)
 	})
-	t.Run("failed get project domain attribute", func(t *testing.T) {
+	t.Run("failed to get project domain attribute", func(t *testing.T) {
 		var args []string
 		setup()
 		getExecutionClusterLabelSetup()
@@ -120,7 +120,7 @@ func TestGetExecutionClusterLabel(t *testing.T) {
 			admin.MatchableResource_EXECUTION_CLUSTER_LABEL)
 		tearDownAndVerify(t, `{"project":"dummyProject","domain":"dummyDomain","workflow":"workflow","value":"foo"}`)
 	})
-	t.Run("failed get workflow attribute", func(t *testing.T) {
+	t.Run("failed to get workflow attribute", func(t *testing.T) {
 		var args []string
 		setup()
 		getExecutionClusterLabelSetup()

diff --git a/flytectl/cmd/root.go b/flytectl/cmd/root.go
@@ -44,7 +44,7 @@ func newRootCmd() *cobra.Command {
 		PersistentPreRunE: initConfig,
 		Long:              "FlyteCTL is CLI tool written in go to interact with Flyteadmin service",
 		Short:             "FlyteCTL CLI tool",
-		Use:               "FlyteCTL",
+		Use:               "flytectl",
 		DisableAutoGenTag: true,
 	}
 

diff --git a/flytectl/cmd/sandbox/start.go b/flytectl/cmd/sandbox/start.go
@@ -30,7 +30,7 @@ import (
 )
 
 const (
-	startShort = "Start the flyte sandbox cluster"
+	startShort = "Start the Flyte Sandbox cluster"
 	startLong  = `
 The Flyte Sandbox is a fully standalone minimal environment for running Flyte. It provides a simplified way of running Flyte sandbox as a single Docker container locally.  
 

diff --git a/flytectl/cmd/upgrade/upgrade_test.go b/flytectl/cmd/upgrade/upgrade_test.go
@@ -29,7 +29,7 @@ func TestUpgradeCommand(t *testing.T) {
 	rootCmd := &cobra.Command{
 		Long:              "FlyteCTL is CLI tool written in go to interact with flyteadmin service",
 		Short:             "FlyteCTL CLI tool",
-		Use:               "FlyteCTL",
+		Use:               "flytectl",
 		DisableAutoGenTag: true,
 	}
 	upgradeCmd := SelfUpgrade(rootCmd)

diff --git a/flytectl/cmd/version/version_test.go b/flytectl/cmd/version/version_test.go
@@ -33,7 +33,7 @@ func TestVersionCommand(t *testing.T) {
 	rootCmd := &cobra.Command{
 		Long:              "FlyteCTL is CLI tool written in go to interact with Flyteadmin service",
 		Short:             "FlyteCTL CLI tool",
-		Use:               "FlyteCTL",
+		Use:               "flytectl",
 		DisableAutoGenTag: true,
 	}
 	versionCommand := GetVersionCommand(rootCmd)

diff --git a/flytectl/docs/source/cluster-resource-attribute.rst b/flytectl/docs/source/cluster-resource-attribute.rst
diff --git a/flytectl/docs/source/config.rst b/flytectl/docs/source/config.rst
diff --git a/flytectl/docs/source/examples.rst b/flytectl/docs/source/examples.rst
diff --git a/flytectl/docs/source/execution-cluster-label.rst b/flytectl/docs/source/execution-cluster-label.rst
diff --git a/flytectl/docs/source/execution-queue-attribute.rst b/flytectl/docs/source/execution-queue-attribute.rst
diff --git a/flytectl/docs/source/execution.rst b/flytectl/docs/source/execution.rst
diff --git a/flytectl/docs/source/files.rst b/flytectl/docs/source/files.rst
diff --git a/flytectl/docs/source/gen/FlyteCTL.rst b/flytectl/docs/source/gen/FlyteCTL.rst
diff --git a/flytectl/docs/source/gen/FlyteCTL_completion.rst b/flytectl/docs/source/gen/FlyteCTL_completion.rst
diff --git a/flytectl/docs/source/gen/FlyteCTL_config.rst b/flytectl/docs/source/gen/FlyteCTL_config.rst
diff --git a/flytectl/docs/source/gen/FlyteCTL_config_discover.rst b/flytectl/docs/source/gen/FlyteCTL_config_discover.rst
diff --git a/flytectl/docs/source/gen/FlyteCTL_config_init.rst b/flytectl/docs/source/gen/FlyteCTL_config_init.rst
diff --git a/flytectl/docs/source/gen/FlyteCTL_config_validate.rst b/flytectl/docs/source/gen/FlyteCTL_config_validate.rst
diff --git a/flytectl/docs/source/gen/FlyteCTL_create.rst b/flytectl/docs/source/gen/FlyteCTL_create.rst
diff --git a/flytectl/docs/source/gen/FlyteCTL_create_execution.rst b/flytectl/docs/source/gen/FlyteCTL_create_execution.rst