Update documentation (flyteorg#239)

* Update documentation Signed-off-by: Flyte-Bot <admin@flyte.org> * update Signed-off-by: Samhita Alla <aallasamhita@gmail.com> * make gendocs Signed-off-by: Samhita Alla <aallasamhita@gmail.com> Co-authored-by: evalsocket <evalsocket@users.noreply.github.com> Co-authored-by: Samhita Alla <aallasamhita@gmail.com>
austin362667 · May 7, 2024 · 9830b37 · 9830b37
1 parent 54d3579
commit 9830b37
Show file tree

Hide file tree

Showing 10 changed files with 62 additions and 32 deletions.
diff --git a/flytectl/cmd/get/execution.go b/flytectl/cmd/get/execution.go
@@ -39,7 +39,8 @@ Retrieve executions as per the specified limit and sorting parameters:
 
  flytectl get execution -p flytesnacks -d development --filter.sortBy=created_at --filter.limit=1 --filter.asc
 
-Retrieves all the executions on other pages.
+Retrieve executions present in other pages by specifying the limit and page number:
+
 ::
 
  flytectl get -p flytesnacks -d development execution --filter.limit=10 --filter.page=2

diff --git a/flytectl/cmd/get/launch_plan.go b/flytectl/cmd/get/launch_plan.go
@@ -56,7 +56,7 @@ Retrieve all the launch plans with limit and sorting:
 
   flytectl get launchplan -p flytesnacks -d development --filter.sortBy=created_at --filter.limit=1 --filter.asc
 
-Retrieves all the launch plans on other pages.
+Retrieve launch plans present in other pages by specifying the limit and page number:
 ::
 
   flytectl get -p flytesnacks -d development launchplan --filter.limit=10 --filter.page=2

diff --git a/flytectl/cmd/get/project.go b/flytectl/cmd/get/project.go
@@ -38,7 +38,7 @@ Retrieve all the projects with limit and sorting:
 
   flytectl get project --filter.sortBy=created_at --filter.limit=1 --filter.asc
 
-Retrieves all the projects on other pages.
+Retrieve projects present in other pages by specifying the limit and page number:
 ::
 
   flytectl get project --filter.limit=10 --filter.page=2

diff --git a/flytectl/cmd/get/task.go b/flytectl/cmd/get/task.go
@@ -54,7 +54,7 @@ Retrieve all the tasks with limit and sorting:
 
   flytectl get -p flytesnacks -d development task  --filter.sortBy=created_at --filter.limit=1 --filter.asc
 
-Retrieves all the task on other pages.
+Retrieve tasks present in other pages by specifying the limit and page number:
 ::
 
   flytectl get -p flytesnacks -d development task --filter.limit=10 --filter.page=2

diff --git a/flytectl/cmd/get/workflow.go b/flytectl/cmd/get/workflow.go
@@ -56,7 +56,7 @@ Retrieve all the workflows with limit and sorting:
 
   flytectl get -p flytesnacks -d development workflow  --filter.sortBy=created_at --filter.limit=1 --filter.asc
 
-Retrieves all the workflows on other pages.
+Retrieve workflows present in other pages by specifying the limit and page number:
 ::
 
   flytectl get -p flytesnacks -d development workflow --filter.limit=10 --filter.page 2

diff --git a/flytectl/docs/source/gen/flytectl_get_execution.rst b/flytectl/docs/source/gen/flytectl_get_execution.rst
diff --git a/flytectl/docs/source/gen/flytectl_get_launchplan.rst b/flytectl/docs/source/gen/flytectl_get_launchplan.rst
diff --git a/flytectl/docs/source/gen/flytectl_get_project.rst b/flytectl/docs/source/gen/flytectl_get_project.rst
diff --git a/flytectl/docs/source/gen/flytectl_get_task.rst b/flytectl/docs/source/gen/flytectl_get_task.rst
diff --git a/flytectl/docs/source/gen/flytectl_get_workflow.rst b/flytectl/docs/source/gen/flytectl_get_workflow.rst