Skip to content

Commit

Permalink
fix
Browse files Browse the repository at this point in the history
  • Loading branch information
badra001 committed Mar 14, 2023
1 parent 7b8b958 commit 8fce01a
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
8 changes: 4 additions & 4 deletions standard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ non-FTI Data. This includes
Other configurations such as versioning or data safegurad tagging (only on the bucket/keys) are oiptional

# Usage
To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off.
If you are converting an older version of the module to the new AWS provider with `?ref=3, please follow
To use the new refactored module with the AWS provider v4.x, use `?ref=tf-upgrade` (formerly `?ref=3`), otherwise leave this part off.
If you are converting an older version of the module to the new AWS provider with `?ref=tf-upgrade`, please follow
the [updating directions](updating-buckets.md).

**Note**: version 2 and version 3 of this module cannot coexist in a directory. All S3 buckets using this module
must use the same version. If you are using the version 2 of the module (without the `?ref=3`), you must
must use the same version. If you are using the version 2 of the module (without the `?ref=tf-upgrade`), you must
also include a `versions.tf` which pins the AWS provider at < 4.0. If using version 3 of the module,
do not include a `versions.tf`, do not pin the AWS provider. Two different versions of the provider cannot
coexist (easily).

````hcl
```hcl
module "my-bucket" {
source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//standard?ref=3"
Expand Down
6 changes: 3 additions & 3 deletions standard/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
* Other configurations such as versioning or data safegurad tagging (only on the bucket/keys) are oiptional
*
* # Usage
* To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off.
* If you are converting an older version of the module to the new AWS provider with `?ref=3, please follow
* To use the new refactored module with the AWS provider v4.x, use `?ref=tf-upgrade` (formerly `?ref=3`), otherwise leave this part off.
* If you are converting an older version of the module to the new AWS provider with `?ref=tf-upgrade`, please follow
* the [updating directions](updating-buckets.md).
*
* **Note**: version 2 and version 3 of this module cannot coexist in a directory. All S3 buckets using this module
* must use the same version. If you are using the version 2 of the module (without the `?ref=3`), you must
* must use the same version. If you are using the version 2 of the module (without the `?ref=tf-upgrade`), you must
* also include a `versions.tf` which pins the AWS provider at < 4.0. If using version 3 of the module,
* do not include a `versions.tf`, do not pin the AWS provider. Two different versions of the provider cannot
* coexist (easily).
Expand Down
8 changes: 4 additions & 4 deletions title26/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ FTI (Title26). This includes
- Server Access Logging

# Usage
To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off.
If you are converting an older version of the module to the new AWS provider with `?ref=3, please follow
To use the new refactored module with the AWS provider v4.x, use `?ref=tf-upgrade` (formerly `?ref=tf-3`), otherwise leave this part off.
If you are converting an older version of the module to the new AWS provider with `?ref=tf-upgrade`, please follow
the [updating directions](updating-buckets.md).

**Note**: version 2 and version 3 of this module cannot coexist in a directory. All S3 buckets using this module
must use the same version. If you are using the version 2 of the module (without the `?ref=3`), you must
must use the same version. If you are using the version 2 of the module (without the `?ref=tf-upgrade`), you must
also include a `versions.tf` which pins the AWS provider at < 4.0. If using version 3 of the module,
do not include a `versions.tf`, do not pin the AWS provider. Two different versions of the provider cannot
coexist (easily).

````hcl
```hcl
module "mybucket" {
source = "git@github.e.it.census.gov:terraform-modules/aws-s3.git//title26?ref=3"
Expand Down
6 changes: 3 additions & 3 deletions title26/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
* - Server Access Logging
*
* # Usage
* To use the new refactored module with the AWS provider v4.x, use `?ref=3`, otherwise leave this part off.
* If you are converting an older version of the module to the new AWS provider with `?ref=3, please follow
* To use the new refactored module with the AWS provider v4.x, use `?ref=tf-upgrade` (formerly `?ref=tf-3`), otherwise leave this part off.
* If you are converting an older version of the module to the new AWS provider with `?ref=tf-upgrade`, please follow
* the [updating directions](updating-buckets.md).
*
* **Note**: version 2 and version 3 of this module cannot coexist in a directory. All S3 buckets using this module
* must use the same version. If you are using the version 2 of the module (without the `?ref=3`), you must
* must use the same version. If you are using the version 2 of the module (without the `?ref=tf-upgrade`), you must
* also include a `versions.tf` which pins the AWS provider at < 4.0. If using version 3 of the module,
* do not include a `versions.tf`, do not pin the AWS provider. Two different versions of the provider cannot
* coexist (easily).
Expand Down

0 comments on commit 8fce01a

Please sign in to comment.