Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

Commit

Permalink
Doc fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Prafulla Mahindrakar <[email protected]>
  • Loading branch information
pmahindrakar-oss committed May 14, 2021
1 parent 57ceb9f commit 707ce66
Show file tree
Hide file tree
Showing 18 changed files with 20 additions and 23 deletions.
4 changes: 2 additions & 2 deletions cmd/delete/matchable_execution_cluster_label.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/get/matchable_cluster_resource_attribute.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/get/matchable_execution_cluster_label.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/get/matchable_execution_queue_attribute.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/get/matchable_task_resource_attribute.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/update/matchable_cluster_resource_attribute.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 1 addition & 4 deletions cmd/update/matchable_execution_cluster_label.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/update/matchable_execution_queue_attribute.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/update/matchable_task_resource_attribute.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/gen/flytectl_delete_execution-cluster-label.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/gen/flytectl_get_execution-cluster-label.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/gen/flytectl_get_execution-queue-attribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/gen/flytectl_get_task-resource-attribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 707ce66

Please sign in to comment.