Flytectl Doc fixes (#38)

* Flytectl Doc fixes * removed tab characters Co-authored-by: pmahindrakar <[email protected]>
flyteorg · Feb 25, 2021 · 3eb2ea3 · 3eb2ea3
1 parent a2c4dd3
commit 3eb2ea3
Show file tree

Hide file tree

Showing 12 changed files with 22 additions and 22 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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.
 ::
-Original file line number
+Diff line change
@@ Expand Up / @@ -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
     ::
@@ Expand Down @@