Skip to content

Commit

Permalink
fix: Update documentation to remove prior notice and deprecated workf…
Browse files Browse the repository at this point in the history
…low (#1)
  • Loading branch information
bryantbiggs committed Apr 21, 2022
1 parent 1d279c7 commit 453c022
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 63 deletions.
39 changes: 0 additions & 39 deletions .github/workflows/semantic-releaser.yml

This file was deleted.

23 changes: 7 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,10 @@
# AWS AppConfig Terraform module

## ⚠️ Module has moved to `terraform-aws-modules`

This module has moved to the terraform-aws-modules organization. Users will need to update their module source:

```diff
- source = "clowdhaus/appconfig/aws"
+ source = "terraform-aws-modules/appconfig/aws"
```

Terraform module which creates AWS AppConfig resources.

## Usage

See [`examples`](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples) directory for working examples to reference:
See [`examples`](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples) directory for working examples to reference:

```hcl
module "appconfig" {
Expand Down Expand Up @@ -74,13 +65,13 @@ module "appconfig" {

## Examples

Examples codified under the [`examples`](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples) are intended
Examples codified under the [`examples`](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples) are intended
give users references for how to use the module(s) as well as testing/validating changes to the source code of the module(s). If contributing to the project, please be sure to make any appropriate updates to the relevant examples to allow maintainers to test your changes and to keep the examples up to date for users. Thank you!

- [AppConfig Hosted](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/appconfig_hosted)
- [S3](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/s3)
- [SSM Document](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/ssm_document)
- [SSM Parameter](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/ssm_parameter)
- [AppConfig Hosted](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/appconfig_hosted)
- [S3](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/s3)
- [SSM Document](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/ssm_document)
- [SSM Parameter](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/ssm_parameter)

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements
Expand Down Expand Up @@ -194,4 +185,4 @@ No modules.

## License

Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/main/LICENSE).
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/master/LICENSE).
8 changes: 4 additions & 4 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Terraform AWS AppConfig examples

- [AppConfig Hosted](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/appconfig_hosted)
- [S3](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/s3)
- [SSM Document](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/ssm_document)
- [SSM Parameter](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/main/examples/ssm_parameter)
- [AppConfig Hosted](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/appconfig_hosted)
- [S3](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/s3)
- [SSM Document](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/ssm_document)
- [SSM Parameter](https://github.com/terraform-aws-modules/terraform-aws-appconfig/tree/master/examples/ssm_parameter)
2 changes: 1 addition & 1 deletion examples/appconfig_hosted/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ No inputs.
| <a name="output_retrieval_role_unique_id"></a> [retrieval\_role\_unique\_id](#output\_retrieval\_role\_unique\_id) | Stable and unique string identifying the retrieval role |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/main/LICENSE).
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/master/LICENSE).
2 changes: 1 addition & 1 deletion examples/s3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,4 @@ No inputs.
| <a name="output_retrieval_role_unique_id"></a> [retrieval\_role\_unique\_id](#output\_retrieval\_role\_unique\_id) | Stable and unique string identifying the retrieval role |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/main/LICENSE).
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/master/LICENSE).
2 changes: 1 addition & 1 deletion examples/ssm_document/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,4 @@ No inputs.
| <a name="output_retrieval_role_unique_id"></a> [retrieval\_role\_unique\_id](#output\_retrieval\_role\_unique\_id) | Stable and unique string identifying the retrieval role |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/main/LICENSE).
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/master/LICENSE).
2 changes: 1 addition & 1 deletion examples/ssm_parameter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ No inputs.
| <a name="output_retrieval_role_unique_id"></a> [retrieval\_role\_unique\_id](#output\_retrieval\_role\_unique\_id) | Stable and unique string identifying the retrieval role |
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/main/LICENSE).
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-appconfig/blob/master/LICENSE).

0 comments on commit 453c022

Please sign in to comment.