From 707ce662a38c6e53ec0b9f96e7b4e61c7843285a Mon Sep 17 00:00:00 2001 From: Prafulla Mahindrakar Date: Fri, 14 May 2021 13:39:31 +0530 Subject: [PATCH] Doc fixes Signed-off-by: Prafulla Mahindrakar --- cmd/delete/matchable_execution_cluster_label.go | 4 ++-- cmd/get/matchable_cluster_resource_attribute.go | 2 +- cmd/get/matchable_execution_cluster_label.go | 2 +- cmd/get/matchable_execution_queue_attribute.go | 2 +- cmd/get/matchable_task_resource_attribute.go | 2 +- cmd/update/matchable_cluster_resource_attribute.go | 2 +- cmd/update/matchable_execution_cluster_label.go | 5 +---- cmd/update/matchable_execution_queue_attribute.go | 2 +- cmd/update/matchable_task_resource_attribute.go | 2 +- docs/source/gen/flytectl_delete_execution-cluster-label.rst | 4 ++-- docs/source/gen/flytectl_get_cluster-resource-attribute.rst | 2 +- docs/source/gen/flytectl_get_execution-cluster-label.rst | 2 +- docs/source/gen/flytectl_get_execution-queue-attribute.rst | 2 +- docs/source/gen/flytectl_get_task-resource-attribute.rst | 2 +- .../gen/flytectl_update_cluster-resource-attribute.rst | 2 +- docs/source/gen/flytectl_update_execution-cluster-label.rst | 2 +- .../source/gen/flytectl_update_execution-queue-attribute.rst | 2 +- docs/source/gen/flytectl_update_task-resource-attribute.rst | 2 +- 18 files changed, 20 insertions(+), 23 deletions(-) diff --git a/cmd/delete/matchable_execution_cluster_label.go b/cmd/delete/matchable_execution_cluster_label.go index 28c9aec88..65ab8f740 100644 --- a/cmd/delete/matchable_execution_cluster_label.go +++ b/cmd/delete/matchable_execution_cluster_label.go @@ -13,10 +13,10 @@ import ( const ( executionClusterLabelShort = "Deletes matchable resources of execution cluster label" executionClusterLabelLong = ` -Deletes execution clyuster label for given project and domain combination or additionally with workflow name. +Deletes execution cluster label for given project and domain combination or additionally with workflow name. Deletes execution cluster label for project and domain -Here the command delete execution cluster label for project flytectldemo and development domain. +Here the command delete execution cluster label for project flytectldemo and development domain. :: flytectl delete execution-cluster-label -p flytectldemo -d development diff --git a/cmd/get/matchable_cluster_resource_attribute.go b/cmd/get/matchable_cluster_resource_attribute.go index 7df8190d0..e29f61d5a 100644 --- a/cmd/get/matchable_cluster_resource_attribute.go +++ b/cmd/get/matchable_cluster_resource_attribute.go @@ -28,7 +28,7 @@ eg : output from the command {"project":"flytectldemo","domain":"development","attributes":{"buzz":"lightyear","foo":"bar"}} Retrieves cluster resource attribute for project and domain and workflow -Here the command get cluster resource attributes for project flytectldemo ,development domain and workflow core.control_flow.run_merge_sort.merge_sort +Here the command get cluster resource attributes for project flytectldemo, development domain and workflow core.control_flow.run_merge_sort.merge_sort :: flytectl get cluster-resource-attribute -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort diff --git a/cmd/get/matchable_execution_cluster_label.go b/cmd/get/matchable_execution_cluster_label.go index 5744950af..56e9e7b94 100644 --- a/cmd/get/matchable_execution_cluster_label.go +++ b/cmd/get/matchable_execution_cluster_label.go @@ -28,7 +28,7 @@ eg : output from the command {"project":"flytectldemo","domain":"development","value":"foo"} Retrieves execution cluster label for project and domain and workflow -Here the command get execution cluster label for project flytectldemo ,development domain and workflow core.control_flow.run_merge_sort.merge_sort +Here the command get execution cluster label for project flytectldemo, development domain and workflow core.control_flow.run_merge_sort.merge_sort :: flytectl get execution-cluster-label -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort diff --git a/cmd/get/matchable_execution_queue_attribute.go b/cmd/get/matchable_execution_queue_attribute.go index 07e51e3d9..b51517e59 100644 --- a/cmd/get/matchable_execution_queue_attribute.go +++ b/cmd/get/matchable_execution_queue_attribute.go @@ -28,7 +28,7 @@ eg : output from the command {"project":"flytectldemo","domain":"development","tags":["foo", "bar"]} Retrieves execution queue attribute for project and domain and workflow -Here the command get execution queue attributes for project flytectldemo ,development domain and workflow core.control_flow.run_merge_sort.merge_sort +Here the command get execution queue attributes for project flytectldemo, development domain and workflow core.control_flow.run_merge_sort.merge_sort :: flytectl get execution-queue-attribute -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort diff --git a/cmd/get/matchable_task_resource_attribute.go b/cmd/get/matchable_task_resource_attribute.go index b3ba8023c..74c8a9a99 100644 --- a/cmd/get/matchable_task_resource_attribute.go +++ b/cmd/get/matchable_task_resource_attribute.go @@ -28,7 +28,7 @@ eg : output from the command {"project":"flytectldemo","domain":"development","workflow":"","defaults":{"cpu":"1","memory":"150Mi"},"limits":{"cpu":"2","memory":"450Mi"}} Retrieves task resource attribute for project and domain and workflow -Here the command get task resource attributes for project flytectldemo ,development domain and workflow core.control_flow.run_merge_sort.merge_sort +Here the command get task resource attributes for project flytectldemo, development domain and workflow core.control_flow.run_merge_sort.merge_sort :: flytectl get task-resource-attribute -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort diff --git a/cmd/update/matchable_cluster_resource_attribute.go b/cmd/update/matchable_cluster_resource_attribute.go index 77b0821c7..c41b74f23 100644 --- a/cmd/update/matchable_cluster_resource_attribute.go +++ b/cmd/update/matchable_cluster_resource_attribute.go @@ -35,7 +35,7 @@ resource attribute defined at project domain level. Also this will completely overwrite any existing custom project and domain and workflow combination attributes. Would be preferable to do get and generate an attribute file if there is an existing attribute already set and then update it to have new values Refer to get cluster-resource-attribute section on how to generate this file -Update the cluster resource attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo , development domain +Update the cluster resource attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain .. code-block:: yaml diff --git a/cmd/update/matchable_execution_cluster_label.go b/cmd/update/matchable_execution_cluster_label.go index 1a8dfe667..0a3eb6965 100644 --- a/cmd/update/matchable_execution_cluster_label.go +++ b/cmd/update/matchable_execution_cluster_label.go @@ -15,9 +15,6 @@ const ( Updates execution cluster label for given project and domain combination or additionally with workflow name. Updating to the execution cluster label is only available from a generated file. See the get section for generating this file. -Also this will completely overwrite any existing custom label on project and domain and workflow combination. -Would be preferable to do get and generate an attribute file if there is an existing attribute already set and then update it to have new values -Refer to get execution-cluster-label section on how to generate this file Here the command updates takes the input for execution cluster label from the config file ecl.yaml eg: content of ecl.yaml @@ -33,7 +30,7 @@ eg: content of ecl.yaml Updating execution cluster label for project and domain and workflow combination. This will take precedence over any other execution cluster label defined at project domain level. -Update the execution cluster label for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo , development domain +Update the execution cluster label for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain .. code-block:: yaml diff --git a/cmd/update/matchable_execution_queue_attribute.go b/cmd/update/matchable_execution_queue_attribute.go index 676c35139..f48bfa2d3 100644 --- a/cmd/update/matchable_execution_queue_attribute.go +++ b/cmd/update/matchable_execution_queue_attribute.go @@ -37,7 +37,7 @@ eg: content of era.yaml Updating execution queue attribute for project and domain and workflow combination. This will take precedence over any other execution queue attribute defined at project domain level. -Update the execution queue attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo , development domain +Update the execution queue attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain .. code-block:: yaml diff --git a/cmd/update/matchable_task_resource_attribute.go b/cmd/update/matchable_task_resource_attribute.go index 3e351baa9..1719dc9c4 100644 --- a/cmd/update/matchable_task_resource_attribute.go +++ b/cmd/update/matchable_task_resource_attribute.go @@ -38,7 +38,7 @@ eg: content of tra.yaml Updating task resource attribute for project and domain and workflow combination. This will take precedence over any other resource attribute defined at project domain level. -Update the resource attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo , development domain +Update the resource attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain .. code-block:: yaml diff --git a/docs/source/gen/flytectl_delete_execution-cluster-label.rst b/docs/source/gen/flytectl_delete_execution-cluster-label.rst index 7feb94cfd..9290a5444 100644 --- a/docs/source/gen/flytectl_delete_execution-cluster-label.rst +++ b/docs/source/gen/flytectl_delete_execution-cluster-label.rst @@ -10,10 +10,10 @@ Synopsis -Deletes execution clyuster label for given project and domain combination or additionally with workflow name. +Deletes execution cluster label for given project and domain combination or additionally with workflow name. Deletes execution cluster label for project and domain -Here the command delete execution cluster label for project flytectldemo and development domain. +Here the command delete execution cluster label for project flytectldemo and development domain. :: flytectl delete execution-cluster-label -p flytectldemo -d development diff --git a/docs/source/gen/flytectl_get_cluster-resource-attribute.rst b/docs/source/gen/flytectl_get_cluster-resource-attribute.rst index 5dfa50b3e..060677972 100644 --- a/docs/source/gen/flytectl_get_cluster-resource-attribute.rst +++ b/docs/source/gen/flytectl_get_cluster-resource-attribute.rst @@ -25,7 +25,7 @@ eg : output from the command {"project":"flytectldemo","domain":"development","attributes":{"buzz":"lightyear","foo":"bar"}} Retrieves cluster resource attribute for project and domain and workflow -Here the command get cluster resource attributes for project flytectldemo ,development domain and workflow core.control_flow.run_merge_sort.merge_sort +Here the command get cluster resource attributes for project flytectldemo, development domain and workflow core.control_flow.run_merge_sort.merge_sort :: flytectl get cluster-resource-attribute -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort diff --git a/docs/source/gen/flytectl_get_execution-cluster-label.rst b/docs/source/gen/flytectl_get_execution-cluster-label.rst index a79842f60..e8752979d 100644 --- a/docs/source/gen/flytectl_get_execution-cluster-label.rst +++ b/docs/source/gen/flytectl_get_execution-cluster-label.rst @@ -25,7 +25,7 @@ eg : output from the command {"project":"flytectldemo","domain":"development","value":"foo"} Retrieves execution cluster label for project and domain and workflow -Here the command get execution cluster label for project flytectldemo ,development domain and workflow core.control_flow.run_merge_sort.merge_sort +Here the command get execution cluster label for project flytectldemo, development domain and workflow core.control_flow.run_merge_sort.merge_sort :: flytectl get execution-cluster-label -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort diff --git a/docs/source/gen/flytectl_get_execution-queue-attribute.rst b/docs/source/gen/flytectl_get_execution-queue-attribute.rst index db008340a..b9eff077b 100644 --- a/docs/source/gen/flytectl_get_execution-queue-attribute.rst +++ b/docs/source/gen/flytectl_get_execution-queue-attribute.rst @@ -25,7 +25,7 @@ eg : output from the command {"project":"flytectldemo","domain":"development","tags":["foo", "bar"]} Retrieves execution queue attribute for project and domain and workflow -Here the command get execution queue attributes for project flytectldemo ,development domain and workflow core.control_flow.run_merge_sort.merge_sort +Here the command get execution queue attributes for project flytectldemo, development domain and workflow core.control_flow.run_merge_sort.merge_sort :: flytectl get execution-queue-attribute -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort diff --git a/docs/source/gen/flytectl_get_task-resource-attribute.rst b/docs/source/gen/flytectl_get_task-resource-attribute.rst index 7b4fa5ba7..a49cb1f96 100644 --- a/docs/source/gen/flytectl_get_task-resource-attribute.rst +++ b/docs/source/gen/flytectl_get_task-resource-attribute.rst @@ -25,7 +25,7 @@ eg : output from the command {"project":"flytectldemo","domain":"development","workflow":"","defaults":{"cpu":"1","memory":"150Mi"},"limits":{"cpu":"2","memory":"450Mi"}} Retrieves task resource attribute for project and domain and workflow -Here the command get task resource attributes for project flytectldemo ,development domain and workflow core.control_flow.run_merge_sort.merge_sort +Here the command get task resource attributes for project flytectldemo, development domain and workflow core.control_flow.run_merge_sort.merge_sort :: flytectl get task-resource-attribute -p flytectldemo -d development core.control_flow.run_merge_sort.merge_sort diff --git a/docs/source/gen/flytectl_update_cluster-resource-attribute.rst b/docs/source/gen/flytectl_update_cluster-resource-attribute.rst index f17c81d62..1646cdfc9 100644 --- a/docs/source/gen/flytectl_update_cluster-resource-attribute.rst +++ b/docs/source/gen/flytectl_update_cluster-resource-attribute.rst @@ -33,7 +33,7 @@ resource attribute defined at project domain level. Also this will completely overwrite any existing custom project and domain and workflow combination attributes. Would be preferable to do get and generate an attribute file if there is an existing attribute already set and then update it to have new values Refer to get cluster-resource-attribute section on how to generate this file -Update the cluster resource attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo , development domain +Update the cluster resource attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain .. code-block:: yaml diff --git a/docs/source/gen/flytectl_update_execution-cluster-label.rst b/docs/source/gen/flytectl_update_execution-cluster-label.rst index fbb282fb4..0eea79f26 100644 --- a/docs/source/gen/flytectl_update_execution-cluster-label.rst +++ b/docs/source/gen/flytectl_update_execution-cluster-label.rst @@ -31,7 +31,7 @@ eg: content of ecl.yaml Updating execution cluster label for project and domain and workflow combination. This will take precedence over any other execution cluster label defined at project domain level. -Update the execution cluster label for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo , development domain +Update the execution cluster label for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain .. code-block:: yaml diff --git a/docs/source/gen/flytectl_update_execution-queue-attribute.rst b/docs/source/gen/flytectl_update_execution-queue-attribute.rst index e7aa20630..85f28eec5 100644 --- a/docs/source/gen/flytectl_update_execution-queue-attribute.rst +++ b/docs/source/gen/flytectl_update_execution-queue-attribute.rst @@ -35,7 +35,7 @@ eg: content of era.yaml Updating execution queue attribute for project and domain and workflow combination. This will take precedence over any other execution queue attribute defined at project domain level. -Update the execution queue attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo , development domain +Update the execution queue attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain .. code-block:: yaml diff --git a/docs/source/gen/flytectl_update_task-resource-attribute.rst b/docs/source/gen/flytectl_update_task-resource-attribute.rst index 8e1308050..37c3439ef 100644 --- a/docs/source/gen/flytectl_update_task-resource-attribute.rst +++ b/docs/source/gen/flytectl_update_task-resource-attribute.rst @@ -36,7 +36,7 @@ eg: content of tra.yaml Updating task resource attribute for project and domain and workflow combination. This will take precedence over any other resource attribute defined at project domain level. -Update the resource attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo , development domain +Update the resource attributes for workflow core.control_flow.run_merge_sort.merge_sort in flytectldemo, development domain .. code-block:: yaml