Improve docs for location

shakacode · Nov 17, 2023 · a4afeeb · a4afeeb
1 parent 3895bf5
commit a4afeeb
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -165,7 +165,10 @@ aliases:
     # Production apps will use a different organization, specified below, for security.
     cpln_org: my-org-staging
 
-    # Example apps use only one location. Control Plane offers the ability to use multiple locations.
+    # Control Plane offers the ability to use multiple locations.
+    # default_location is used for commands that require a location
+    # including `ps`, `run`, `run:detached`, `apply-template`.
+    # This can be overridden with option --location=<location>
     default_location: aws-us-east-2
 
     # Allows running the command `cpl setup-app`

diff --git a/examples/controlplane.yml b/examples/controlplane.yml
@@ -6,7 +6,10 @@ aliases:
     # Production apps will use a different organization, specified below, for security.
     cpln_org: my-org-staging
 
-    # Example apps use only one location. Control Plane offers the ability to use multiple locations.
+    # Control Plane offers the ability to use multiple locations.
+    # default_location is used for commands that require a location:
+    # including `ps`, `run`, `run:detached`, `apply-template`
+    # This can be overridden with option --location=<location>
     # TODO: Allow specification of multiple locations.
     default_location: aws-us-east-2