adding docs for the list-launches command

awslabs · Apr 29, 2019 · c698b80 · c698b80
1 parent 8397942
commit c698b80
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,4 +9,5 @@ Welcome to aws-service-catalog-puppets's documentation!
    puppet/getting_up_and_running
    puppet/designing_your_manifest
    puppet/notifications
+   puppet/utils
    puppet/upgrading
diff --git a/docs/source/puppet/utils.md b/docs/source/puppet/utils.md
@@ -0,0 +1,20 @@
+Utils
+=====
+
+The following utils will help you manage your AWS Accounts when using ServiceCatalog-Puppet:
+
+
+## list-launches
+The list-launches command can currently only be invoked on an expanded manifest.yaml file.  To 
+expand your manifest you must run the following:
+
+```bash
+servicecatalog-puppet expand manifest.yaml
+```
+
+This will create a file named ```manifest-expanded.yaml in the same directory```.
+
+You can then run ```list-launches```:
+```bash
+servicecatalog-puppet list-launches manifest-expanded.yaml
+```