From b3242a84d7eb111b1db235e0c4541c95d235db1c Mon Sep 17 00:00:00 2001 From: Eric Beard Date: Wed, 2 Oct 2024 08:55:55 -0700 Subject: [PATCH] Generate docs --- README.md | 2 ++ docs/README.tmpl | 2 +- docs/bash_completion.sh | 2 ++ docs/index.md | 2 +- docs/rain_bootstrap.md | 2 +- docs/rain_build.md | 2 +- docs/rain_cat.md | 2 +- docs/rain_cc.md | 2 +- docs/rain_cc_deploy.md | 2 +- docs/rain_cc_drift.md | 2 +- docs/rain_cc_rm.md | 2 +- docs/rain_cc_state.md | 2 +- docs/rain_console.md | 2 +- docs/rain_deploy.md | 4 ++-- docs/rain_diff.md | 2 +- docs/rain_fmt.md | 2 +- docs/rain_forecast.md | 2 +- docs/rain_info.md | 2 +- docs/rain_logs.md | 2 +- docs/rain_ls.md | 2 +- docs/rain_merge.md | 2 +- docs/rain_module.md | 2 +- docs/rain_module_bootstrap.md | 2 +- docs/rain_module_install.md | 2 +- docs/rain_module_publish.md | 2 +- docs/rain_pkg.md | 2 +- docs/rain_rm.md | 3 ++- docs/rain_stackset.md | 2 +- docs/rain_stackset_deploy.md | 2 +- docs/rain_stackset_ls.md | 2 +- docs/rain_stackset_rm.md | 2 +- docs/rain_tree.md | 2 +- docs/rain_watch.md | 2 +- 33 files changed, 37 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index a8f44d4f..91ba0ce7 100644 --- 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 index 01ac6326..af40f2e1 100644 --- 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 index 5027aa55..502e4a9d 100644 --- 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 index ed82966d..6d03247b 100644 --- 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 index dee4cb97..cb4c89f8 100644 --- 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 index 50929baa..05230b7f 100644 --- a/docs/rain_build.md +++ b/docs/rain_build.md @@ -41,4 +41,4 @@ rain build [] or * [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 index 08c437aa..b7137c67 100644 --- a/docs/rain_cat.md +++ b/docs/rain_cat.md @@ -35,4 +35,4 @@ rain cat * [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 index 3d1ff904..e362fde2 100644 --- 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 index a4b5bdc4..ef755ed9 100644 --- a/docs/rain_cc_deploy.md +++ b/docs/rain_cc_deploy.md @@ -40,4 +40,4 @@ rain cc deploy