Generate docs

aws-cloudformation · Oct 2, 2024 · b3242a8 · b3242a8
1 parent 6327ae5
commit b3242a8
Show file tree

Hide file tree

Showing 33 changed files with 37 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -37,6 +37,8 @@ cfn-lint, Guard and more:
 
 * **Modules** (EXPERIMENTAL): `rain pkg` supports client-side module development with the `!Rain::Module` directive. Rain modules are partial templates that are inserted into the parent template, with some extra functionality added to enable extending existing resource types. This feature integrates with CodeArtifact to enable package publish and install.
 
+* **Content Deployment** (EXPERIMENTAL): `rain deploy` and `rain rm` support metadata commands that can upload static assets to a bucket and then delete those assets when the bucket is deleted. Rain can also run build scripts before and after stack deployment to prepare content like web sites and lambda functions before uploading to S3.
+
 _Note that in order to use experimental commands, you have to add `--experimental` or `-x` as an argument._
 
 ## Getting started

diff --git a/docs/README.tmpl b/docs/README.tmpl
@@ -37,7 +37,7 @@ cfn-lint, Guard and more:
 
 * **Modules** (EXPERIMENTAL): `rain pkg` supports client-side module development with the `!Rain::Module` directive. Rain modules are partial templates that are inserted into the parent template, with some extra functionality added to enable extending existing resource types. This feature integrates with CodeArtifact to enable package publish and install.
 
-* **Content Deployment** (EXPERIMENTAL): `rain deploy` and `rain rm` support metadata commands that can upload static assets to a bucket and then delete those assets when the bucket is deleted. 
+* **Content Deployment** (EXPERIMENTAL): `rain deploy` and `rain rm` support metadata commands that can upload static assets to a bucket and then delete those assets when the bucket is deleted. Rain can also run build scripts before and after stack deployment to prepare content like web sites and lambda functions before uploading to S3.
 
 _Note that in order to use experimental commands, you have to add `--experimental` or `-x` as an argument._
 

diff --git a/docs/bash_completion.sh b/docs/bash_completion.sh
@@ -1710,6 +1710,8 @@ _rain_rm()
     flags+=("-d")
     local_nonpersistent_flags+=("--detach")
     local_nonpersistent_flags+=("-d")
+    flags+=("--experimental")
+    local_nonpersistent_flags+=("--experimental")
     flags+=("--help")
     flags+=("-h")
     local_nonpersistent_flags+=("--help")

diff --git a/docs/index.md b/docs/index.md
@@ -36,4 +36,4 @@ Rain is a command line tool for working with AWS CloudFormation templates and st
 * [rain tree](rain_tree.md)	 - Find dependencies of Resources and Outputs in a local template
 * [rain watch](rain_watch.md)	 - Display an updating view of a CloudFormation stack
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_bootstrap.md b/docs/rain_bootstrap.md
@@ -30,4 +30,4 @@ rain bootstrap
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_build.md b/docs/rain_build.md
@@ -41,4 +41,4 @@ rain build [<resource type>] or <prompt>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_cat.md b/docs/rain_cat.md
@@ -35,4 +35,4 @@ rain cat <stack>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_cc.md b/docs/rain_cc.md
@@ -32,4 +32,4 @@ You must pass the --experimental (-x) flag to use this command, to acknowledge t
 * [rain cc rm](rain_cc_rm.md)	 - Delete a deployment created by cc deploy (Experimental!)
 * [rain cc state](rain_cc_state.md)	 - Download the state file for a template deployed with cc deploy
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_cc_deploy.md b/docs/rain_cc_deploy.md
@@ -40,4 +40,4 @@ rain cc deploy <template> <name>
 
 * [rain cc](rain_cc.md)	 - Interact with templates using Cloud Control API instead of CloudFormation
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_cc_drift.md b/docs/rain_cc_drift.md
@@ -33,4 +33,4 @@ rain cc drift <name>
 
 * [rain cc](rain_cc.md)	 - Interact with templates using Cloud Control API instead of CloudFormation
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_cc_rm.md b/docs/rain_cc_rm.md
@@ -33,4 +33,4 @@ rain cc rm <name>
 
 * [rain cc](rain_cc.md)	 - Interact with templates using Cloud Control API instead of CloudFormation
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_cc_state.md b/docs/rain_cc_state.md
@@ -33,4 +33,4 @@ rain cc state <name>
 
 * [rain cc](rain_cc.md)	 - Interact with templates using Cloud Control API instead of CloudFormation
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_console.md b/docs/rain_console.md
@@ -39,4 +39,4 @@ rain console [stack]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_deploy.md b/docs/rain_deploy.md
@@ -62,7 +62,7 @@ rain deploy <template> [stack]
       --ignore-unknown-params    Ignore unknown parameters
   -k, --keep                     keep deployed resources after a failure by disabling rollbacks
   -x, --no-exec                  do not execute the changeset
-      --node-style string        Set the node output style to tagged, doublequoted, singlequoted, literal, folded, quotescalars, original, or flow
+      --node-style string        Set the node output style to tagged, doublequoted, singlequoted, literal, folded, quotescalars, original, or flow (default "original")
       --params strings           set parameter values; use the format key1=value1,key2=value2
   -p, --profile string           AWS profile name; read from the AWS CLI configuration file
   -r, --region string            AWS region to use
@@ -85,4 +85,4 @@ rain deploy <template> [stack]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_diff.md b/docs/rain_diff.md
@@ -28,4 +28,4 @@ rain diff <from> <to>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_fmt.md b/docs/rain_fmt.md
@@ -37,4 +37,4 @@ rain fmt <filename>...
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_forecast.md b/docs/rain_forecast.md
@@ -55,4 +55,4 @@ rain forecast --experimental <template> [stackName]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_info.md b/docs/rain_info.md
@@ -30,4 +30,4 @@ rain info
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_logs.md b/docs/rain_logs.md
@@ -37,4 +37,4 @@ rain logs <stack> (<resource>)
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_ls.md b/docs/rain_ls.md
@@ -31,4 +31,4 @@ rain ls <stack> [changeset]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_merge.md b/docs/rain_merge.md
@@ -30,4 +30,4 @@ rain merge <template> <template> ...
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_module.md b/docs/rain_module.md
@@ -31,4 +31,4 @@ The rain module command can be used to publish modules to CodeArtifact, and to i
 * [rain module install](rain_module_install.md)	 - Install a package of Rain modules from CodeArtifact
 * [rain module publish](rain_module_publish.md)	 - Publish a directory of Rain modules to CodeArtifact
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_module_bootstrap.md b/docs/rain_module_bootstrap.md
@@ -29,4 +29,4 @@ rain module bootstrap [flags]
 
 * [rain module](rain_module.md)	 - Interact with Rain modules in CodeArtifact
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_module_install.md b/docs/rain_module_install.md
@@ -30,4 +30,4 @@ rain module install <name> [flags]
 
 * [rain module](rain_module.md)	 - Interact with Rain modules in CodeArtifact
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_module_publish.md b/docs/rain_module_publish.md
@@ -30,4 +30,4 @@ rain module publish <name> [flags]
 
 * [rain module](rain_module.md)	 - Interact with Rain modules in CodeArtifact
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_pkg.md b/docs/rain_pkg.md
@@ -68,4 +68,4 @@ rain pkg <template>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_rm.md b/docs/rain_rm.md
@@ -15,6 +15,7 @@ rain rm <stack> [changeset]
 ```
   -c, --changeset         delete a changeset
   -d, --detach            once removal has started, don't wait around for it to finish
+      --experimental      Acknowledge that you want to deploy with an experimental feature
   -h, --help              help for rm
   -p, --profile string    AWS profile name; read from the AWS CLI configuration file
   -r, --region string     AWS region to use
@@ -33,4 +34,4 @@ rain rm <stack> [changeset]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_stackset.md b/docs/rain_stackset.md
@@ -28,4 +28,4 @@ This command manipulates stack sets. It has no action if specific stack set comm
 * [rain stackset ls](rain_stackset_ls.md)	 - List a CloudFormation stack sets in a given region
 * [rain stackset rm](rain_stackset_rm.md)	 - Delete a CloudFormation stack set and/or its instances.
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_stackset_deploy.md b/docs/rain_stackset_deploy.md
@@ -65,4 +65,4 @@ rain stackset deploy <template> [stackset] [flags]
 
 * [rain stackset](rain_stackset.md)	 - This command manipulates stack sets.
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_stackset_ls.md b/docs/rain_stackset_ls.md
@@ -31,4 +31,4 @@ rain stackset ls <stack set>
 
 * [rain stackset](rain_stackset.md)	 - This command manipulates stack sets.
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_stackset_rm.md b/docs/rain_stackset_rm.md
@@ -31,4 +31,4 @@ rain stackset rm <stackset>
 
 * [rain stackset](rain_stackset.md)	 - This command manipulates stack sets.
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_tree.md b/docs/rain_tree.md
@@ -30,4 +30,4 @@ rain tree [template]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024
diff --git a/docs/rain_watch.md b/docs/rain_watch.md
@@ -30,4 +30,4 @@ rain watch <stack>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 21-Aug-2024
+###### Auto generated by spf13/cobra on 2-Oct-2024