added use case section

Yelp · Oct 24, 2022 · f1397ff · f1397ff
1 parent 8c44e15
commit f1397ff
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/source/PaaSTA_Development.rst b/docs/source/PaaSTA_Development.rst
@@ -14,6 +14,13 @@ PaaSTA playground allows the developer to run and debug PaaSTA locally on an eph
 * starting the PaaSTA API (the backend that the PaaSTA CLI talks to)
 * configuring the PaaSTA CLI (the interface to interacting with PaaSTA)
 
+PaaSTA playground Use cases
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+There are mainly two use cases for PaaSTA playground:
+
+1) :ref:`If the developer wants to debug different components of PaaSTA <debugging-paasta>`
+2) :ref:`If the developer just wants to run paasta to see a change they developed in PaaSTA components <running-paasta>`
+
 Create a Kind Cluster - K8s Cluster
 -----------------------------------
 
@@ -22,6 +29,8 @@ Before running or debugging PaaSTA playground, you will need to create a Kuberne
 
 To delete the cluster, run ``make clean`` from the ``paasta/k8s_itests`` directory.
 
+.. _debugging-paasta:
+
 Debugging PaaSTA playground (in VS Code)
 ----------------------------------------
 
@@ -90,6 +99,8 @@ Expected output from client:
             compute-infra-test-service-autoscaling-7999bd8fcf  0/10             2022-10-11T06:07 (15 minutes ago)  xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx  configxxxx
 
 
+.. _running-paasta:
+
 Running PaaSTA playground
 -------------------------