Docs: explain cluster states (skypilot-org#2834)

* cross ref cluster states in quickstart * fix formatting Co-authored-by: Zongheng Yang <[email protected]> --------- Co-authored-by: Zongheng Yang <[email protected]>
remyleone · Dec 22, 2023 · 226639a · 226639a
1 parent e49ad55
commit 226639a
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/docs/source/getting-started/quickstart.rst b/docs/source/getting-started/quickstart.rst
@@ -126,6 +126,7 @@ This may show multiple clusters, if you have created several:
   mygcp      1 day ago    1x GCP(n1-highmem-8)  sky launch -c mygcp --cloud gcp    STOPPED
   mycluster  4 mins ago   1x AWS(p3.2xlarge)    sky exec mycluster hello_sky.yaml  UP
 
+See here for a list of all possible :ref:`cluster states <sky-status>`.
 
 .. _ssh:
 

diff --git a/docs/source/reference/cli.rst b/docs/source/reference/cli.rst
@@ -6,45 +6,55 @@ Command Line Interface
 Core CLI
 ---------
 
+.. _sky-launch:
 .. click:: sky.cli:launch
    :prog: sky launch
    :nested: full
 
+.. _sky-exec:
 .. click:: sky.cli:exec
    :prog: sky exec
    :nested: full
 
+.. _sky-stop:
 .. click:: sky.cli:stop
    :prog: sky stop
    :nested: full
 
+.. _sky-start:
 .. click:: sky.cli:start
    :prog: sky start
    :nested: full
 
+.. _sky-down:
 .. click:: sky.cli:down
    :prog: sky down
    :nested: full
 
+.. _sky-status:
 .. click:: sky.cli:status
    :prog: sky status
    :nested: full
 
+.. _sky-autostop:
 .. click:: sky.cli:autostop
    :prog: sky autostop
    :nested: full
 
 Job Queue CLI
 --------------
 
+.. _sky-queue:
 .. click:: sky.cli:queue
    :prog: sky queue
    :nested: full
 
+.. _sky-logs:
 .. click:: sky.cli:logs
    :prog: sky logs
    :nested: full
 
+.. _sky-cancel:
 .. click:: sky.cli:cancel
    :prog: sky cancel
    :nested: full
@@ -53,41 +63,48 @@ Job Queue CLI
 Managed Spot Jobs CLI
 ---------------------------
 
+.. _sky-spot-launch:
 .. click:: sky.cli:spot_launch
    :prog: sky spot launch
    :nested: full
 
+.. _sky-spot-queue:
 .. click:: sky.cli:spot_queue
    :prog: sky spot queue
    :nested: full
 
+.. _sky-spot-cancel:
 .. click:: sky.cli:spot_cancel
    :prog: sky spot cancel
    :nested: full
 
+.. _sky-spot-logs:
 .. click:: sky.cli:spot_logs
    :prog: sky spot logs
    :nested: full
 
 Storage CLI
 ------------
 
+.. _sky-storage-ls:
 .. click:: sky.cli:storage_ls
    :prog: sky storage ls
    :nested: full
 
+.. _sky-storage-delete:
 .. click:: sky.cli:storage_delete
    :prog: sky storage delete
    :nested: full
 
 Utils: ``show-gpus``/``check``/``cost-report``
 -------------------------------------------------
 
-
+.. _sky-show-gpus:
 .. click:: sky.cli:show_gpus
    :prog: sky show-gpus
    :nested: full
 
+.. _sky-check:
 .. click:: sky.cli:check
    :prog: sky check
    :nested: full