Update documentation (#117)

Signed-off-by: Flyte-Bot <[email protected]>

Co-authored-by: kumare3 <[email protected]>

flytectl/docs/source/gen/flytectl.rst

@@ -25,6 +25,7 @@ Options
 SEE ALSO
 ~~~~~~~~
 
+* :doc:`flytectl_completion` 	 - Generate completion script
 * :doc:`flytectl_config` 	 - Runs various config commands, look at the help of this command to get a list of available commands..
 * :doc:`flytectl_create` 	 - Used for creating various flyte resources including tasks/workflows/launchplans/executions/project.
 * :doc:`flytectl_delete` 	 - Used for terminating/deleting various flyte resources including tasks/workflows/launchplans/executions/project.

flytectl/docs/source/gen/flytectl_completion.rst

@@ -0,0 +1,77 @@
+.. _flytectl_completion:
+
+flytectl completion
+-------------------
+
+Generate completion script
+
+Synopsis
+~~~~~~~~
+
+
+To load completions:
+
+Bash:
+
+  $ source <(flytectl completion bash)
+
+  # To load completions for each session, execute once:
+  # Linux:
+  $ flytectl completion bash > /etc/bash_completion.d/flytectl
+  # macOS:
+  $ flytectl completion bash > /usr/local/etc/bash_completion.d/flytectl
+
+Zsh:
+
+  # If shell completion is not already enabled in your environment,
+  # you will need to enable it.  You can execute the following once:
+
+  $ echo "autoload -U compinit; compinit" >> ~/.zshrc
+
+  # To load completions for each session, execute once:
+  $ flytectl completion zsh > "${fpath[1]}/_flytectl"
+
+  # You will need to start a new shell for this setup to take effect.
+
+fish:
+
+  $ flytectl completion fish | source
+
+  # To load completions for each session, execute once:
+  $ flytectl completion fish > ~/.config/fish/completions/flytectl.fish
+
+PowerShell:
+
+  PS> flytectl completion powershell | Out-String | Invoke-Expression
+
+  # To load completions for every new session, run:
+  PS> flytectl completion powershell > flytectl.ps1
+  # and source this file from your PowerShell profile.
+
+
+::
+
+  flytectl completion [bash|zsh|fish|powershell]
+
+Options
+~~~~~~~
+
+::
+
+  -h, --help   help for completion
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+  -c, --config string    config file (default is $HOME/.flyte/config.yaml)
+  -d, --domain string    Specifies the Flyte project's domain.
+  -o, --output string    Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE")
+  -p, --project string   Specifies the Flyte project.
+
+SEE ALSO
+~~~~~~~~
+
+* :doc:`flytectl` 	 - flyetcl CLI tool
+

flytectl/docs/source/gen/flytectl_sandbox.rst

@@ -44,5 +44,6 @@ SEE ALSO
 
 * :doc:`flytectl` 	 - flyetcl CLI tool
 * :doc:`flytectl_sandbox_start` 	 - Start the flyte sandbox
+* :doc:`flytectl_sandbox_status` 	 - Get the status of the sandbox environment.
 * :doc:`flytectl_sandbox_teardown` 	 - Teardown will cleanup the sandbox environment
 

flytectl/docs/source/gen/flytectl_sandbox_start.rst

@@ -18,7 +18,7 @@ Start will run the flyte sandbox cluster inside a docker container and setup the
 Mount your flytesnacks repository code inside sandbox 
 ::
 
- bin/flytectl sandbox start --sourcesPath=$HOME/flyteorg/flytesnacks
+ bin/flytectl sandbox start --sourcesPath=$HOME/flyteorg/flytesnacks 
 Usage
 
 
@@ -31,7 +31,7 @@ Options
 
 ::
 
-      --sourcesPath string   Path to your source code path where flyte workflows and tasks are.
+      --flytesnacks string    Path of your flytesnacks repository
   -h, --help                 help for start
 
 Options inherited from parent commands

flytectl/docs/source/gen/flytectl_sandbox_status.rst

@@ -0,0 +1,48 @@
+.. _flytectl_sandbox_status:
+
+flytectl sandbox status
+-----------------------
+
+Get the status of the sandbox environment.
+
+Synopsis
+~~~~~~~~
+
+
+
+Status will retrieve the status of the Sandbox environment. Currently FlyteSandbox runs as a local docker container.
+This will return the docker status for this container
+
+Usage
+::
+
+ bin/flytectl sandbox status 
+
+
+
+::
+
+  flytectl sandbox status [flags]
+
+Options
+~~~~~~~
+
+::
+
+  -h, --help   help for status
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+  -c, --config string    config file (default is $HOME/.flyte/config.yaml)
+  -d, --domain string    Specifies the Flyte project's domain.
+  -o, --output string    Specifies the output type - supported formats [TABLE JSON YAML DOT DOTURL]. NOTE: dot, doturl are only supported for Workflow (default "TABLE")
+  -p, --project string   Specifies the Flyte project.
+
+SEE ALSO
+~~~~~~~~
+
+* :doc:`flytectl_sandbox` 	 - Used for testing flyte sandbox.
+