From 3eb2ea3a35d196cc4b9fa59d675b57fd33c836ba Mon Sep 17 00:00:00 2001 From: pmahindrakar-oss <77798312+pmahindrakar-oss@users.noreply.github.com> Date: Thu, 25 Feb 2021 08:18:12 +0530 Subject: [PATCH] Flytectl Doc fixes (#38) * Flytectl Doc fixes * removed tab characters Co-authored-by: pmahindrakar --- flytectl/cmd/create/project.go | 12 ++++++------ flytectl/cmd/get/execution.go | 2 +- flytectl/cmd/get/launch_plan.go | 2 +- flytectl/cmd/get/task.go | 2 +- flytectl/cmd/get/workflow.go | 2 +- flytectl/cmd/update/project.go | 2 +- flytectl/docs/source/gen/flytectl_create_project.rst | 12 ++++++------ flytectl/docs/source/gen/flytectl_get_execution.rst | 2 +- flytectl/docs/source/gen/flytectl_get_launchplan.rst | 2 +- flytectl/docs/source/gen/flytectl_get_task.rst | 2 +- flytectl/docs/source/gen/flytectl_get_workflow.rst | 2 +- flytectl/docs/source/gen/flytectl_update_project.rst | 2 +- 12 files changed, 22 insertions(+), 22 deletions(-) diff --git a/flytectl/cmd/create/project.go b/flytectl/cmd/create/project.go index 93a444ea8c..776be99056 100644 --- a/flytectl/cmd/create/project.go +++ b/flytectl/cmd/create/project.go @@ -20,18 +20,18 @@ Create the projects.(project,projects can be used interchangeably in these comma bin/flytectl create project --name flytesnacks --id flytesnacks --description "flytesnacks description" --labels app=flyte -Create Project by definition file +Create Project by definition file. Note: The name shouldn't contain any whitespace characters' :: bin/flytectl create project --file project.yaml .. code-block:: yaml - id: "project-unique-id" - name: "Friendly name" - labels: - app: flyte - description: "Some description for the project" + id: "project-unique-id" + name: "Name" + labels: + app: flyte + description: "Some description for the project" ` ) diff --git a/flytectl/cmd/get/execution.go b/flytectl/cmd/get/execution.go index 0c22e5674e..67ef82b9ac 100644 --- a/flytectl/cmd/get/execution.go +++ b/flytectl/cmd/get/execution.go @@ -26,7 +26,7 @@ Retrieves execution by name within project and domain. :: - bin/flytectl execution -p flytesnacks -d development oeh94k9r2r + bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r Retrieves execution by filters :: diff --git a/flytectl/cmd/get/launch_plan.go b/flytectl/cmd/get/launch_plan.go index 8706a36271..eb4d292e20 100644 --- a/flytectl/cmd/get/launch_plan.go +++ b/flytectl/cmd/get/launch_plan.go @@ -24,7 +24,7 @@ Retrieves launch plan by name within project and domain. :: - bin/flytectl launchplan -p flytesnacks -d development recipes.core.basic.lp.my_wf + bin/flytectl get launchplan -p flytesnacks -d development core.basic.lp.go_greet Retrieves launchplan by filters. :: diff --git a/flytectl/cmd/get/task.go b/flytectl/cmd/get/task.go index 96631d1741..054225e413 100644 --- a/flytectl/cmd/get/task.go +++ b/flytectl/cmd/get/task.go @@ -27,7 +27,7 @@ Retrieves task by name within project and domain. :: - bin/flytectl task -p flytesnacks -d development square + bin/flytectl task -p flytesnacks -d development core.basic.lp.greet Retrieves project by filters. :: diff --git a/flytectl/cmd/get/workflow.go b/flytectl/cmd/get/workflow.go index 857df5bf5b..322a3af0c0 100644 --- a/flytectl/cmd/get/workflow.go +++ b/flytectl/cmd/get/workflow.go @@ -26,7 +26,7 @@ Retrieves workflow by name within project and domain. :: - bin/flytectl workflow -p flytesnacks -d development recipes.plugins.k8s_spark.pyspark_pi.my_spark + bin/flytectl get workflow -p flytesnacks -d development core.basic.lp.go_greet Retrieves workflow by filters. :: diff --git a/flytectl/cmd/update/project.go b/flytectl/cmd/update/project.go index c421dddd2b..15c1c9dc73 100644 --- a/flytectl/cmd/update/project.go +++ b/flytectl/cmd/update/project.go @@ -30,7 +30,7 @@ Archives project named flytesnacks. :: - bin/flytectl get project flytesnacks --archiveProject + bin/flytectl update project -p flytesnacks --archiveProject Activates project named flytesnacks using short option -t. :: diff --git a/flytectl/docs/source/gen/flytectl_create_project.rst b/flytectl/docs/source/gen/flytectl_create_project.rst index 26b8b4e557..3b1aa15100 100644 --- a/flytectl/docs/source/gen/flytectl_create_project.rst +++ b/flytectl/docs/source/gen/flytectl_create_project.rst @@ -16,18 +16,18 @@ Create the projects.(project,projects can be used interchangeably in these comma bin/flytectl create project --name flytesnacks --id flytesnacks --description "flytesnacks description" --labels app=flyte -Create Project by definition file +Create Project by definition file. Note: The name shouldn't contain any whitespace characters' :: bin/flytectl create project --file project.yaml .. code-block:: yaml - id: "project-unique-id" - name: "Friendly name" - labels: - app: flyte - description: "Some description for the project" + id: "project-unique-id" + name: "Name" + labels: + app: flyte + description: "Some description for the project" diff --git a/flytectl/docs/source/gen/flytectl_get_execution.rst b/flytectl/docs/source/gen/flytectl_get_execution.rst index c623b62409..48a01189cc 100644 --- a/flytectl/docs/source/gen/flytectl_get_execution.rst +++ b/flytectl/docs/source/gen/flytectl_get_execution.rst @@ -19,7 +19,7 @@ Retrieves execution by name within project and domain. :: - bin/flytectl execution -p flytesnacks -d development oeh94k9r2r + bin/flytectl get execution -p flytesnacks -d development oeh94k9r2r Retrieves execution by filters :: diff --git a/flytectl/docs/source/gen/flytectl_get_launchplan.rst b/flytectl/docs/source/gen/flytectl_get_launchplan.rst index 8ad77613a5..ab832ed6b5 100644 --- a/flytectl/docs/source/gen/flytectl_get_launchplan.rst +++ b/flytectl/docs/source/gen/flytectl_get_launchplan.rst @@ -19,7 +19,7 @@ Retrieves launch plan by name within project and domain. :: - bin/flytectl launchplan -p flytesnacks -d development recipes.core.basic.lp.my_wf + bin/flytectl get launchplan -p flytesnacks -d development core.basic.lp.go_greet Retrieves launchplan by filters. :: diff --git a/flytectl/docs/source/gen/flytectl_get_task.rst b/flytectl/docs/source/gen/flytectl_get_task.rst index 01587b65ab..3037d96055 100644 --- a/flytectl/docs/source/gen/flytectl_get_task.rst +++ b/flytectl/docs/source/gen/flytectl_get_task.rst @@ -19,7 +19,7 @@ Retrieves task by name within project and domain. :: - bin/flytectl task -p flytesnacks -d development square + bin/flytectl task -p flytesnacks -d development core.basic.lp.greet Retrieves project by filters. :: diff --git a/flytectl/docs/source/gen/flytectl_get_workflow.rst b/flytectl/docs/source/gen/flytectl_get_workflow.rst index e27166be70..4b4a996b2c 100644 --- a/flytectl/docs/source/gen/flytectl_get_workflow.rst +++ b/flytectl/docs/source/gen/flytectl_get_workflow.rst @@ -19,7 +19,7 @@ Retrieves workflow by name within project and domain. :: - bin/flytectl workflow -p flytesnacks -d development recipes.plugins.k8s_spark.pyspark_pi.my_spark + bin/flytectl get workflow -p flytesnacks -d development core.basic.lp.go_greet Retrieves workflow by filters. :: diff --git a/flytectl/docs/source/gen/flytectl_update_project.rst b/flytectl/docs/source/gen/flytectl_update_project.rst index 5df7744a40..d3b2d44096 100644 --- a/flytectl/docs/source/gen/flytectl_update_project.rst +++ b/flytectl/docs/source/gen/flytectl_update_project.rst @@ -20,7 +20,7 @@ Archives project named flytesnacks. :: - bin/flytectl get project flytesnacks --archiveProject + bin/flytectl update project -p flytesnacks --archiveProject Activates project named flytesnacks using short option -t. ::