Skip to content

Commit 8e4cb3c

Browse files
SWhyteAnswerSWhyteAnswer
committed
[NDR-73] reverting readme
1 parent 577c53f commit 8e4cb3c

File tree

19 files changed

+141
-956
lines changed

19 files changed

+141
-956
lines changed

‎README.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -115,17 +115,17 @@ jobs:
115115
docs:
116116
runs-on: ubuntu-latest
117117
steps:
118-
- uses: actions/checkout@v3
119-
with:
120-
ref: ${{ github.event.pull_request.head.ref }}
121-
122-
- name: Render terraform docs and push changes back to PR
123-
uses: terraform-docs/gh-actions@main
124-
with:
125-
working-dir: .
126-
output-file: README.md
127-
output-method: inject
128-
git-push: "true"
118+
- uses: actions/checkout@v3
119+
with:
120+
ref: ${{ github.event.pull_request.head.ref }}
121+
122+
- name: Render terraform docs and push changes back to PR
123+
uses: terraform-docs/gh-actions@main
124+
with:
125+
working-dir: .
126+
output-file: README.md
127+
output-method: inject
128+
git-push: "true"
129129
```
130130
131131
Read more about [terraform-docs GitHub Action] and its configuration and
@@ -145,8 +145,7 @@ repos:
145145
rev: "v0.19.0"
146146
hooks:
147147
- id: terraform-docs-go
148-
args:
149-
["markdown", "table", "--output-file", "README.md", "./mymodule/path"]
148+
args: ["markdown", "table", "--output-file", "README.md", "./mymodule/path"]
150149
```
151150

152151
Then run:
@@ -346,9 +345,9 @@ In order to install a plugin the following steps are needed:
346345
**Important notes:**
347346

348347
- if the plugin file name is different than the example above, terraform-docs won't
349-
be able to to pick it up nor register it properly
348+
be able to to pick it up nor register it properly
350349
- you can only use plugin thorough `.terraform-docs.yml` file and it cannot be used
351-
with CLI arguments
350+
with CLI arguments
352351

353352
To create a new plugin create a new repository called `tfdocs-format-<NAME>` with
354353
following `main.go`:

‎infrastructure/modules/app_config/README.md‎

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -42,24 +42,6 @@ module "app_config" {
4242
## Usage
4343
Basic usage of this module is as follows:
4444

45-
<<<<<<< HEAD
46-
<<<<<<< HEAD
47-
<<<<<<< HEAD
48-
| Name | Version |
49-
|------|---------|
50-
| <a name="provider_aws"></a> [aws](#provider\_aws) | ~> 5.0 |
51-
| <a name="provider_terraform"></a> [terraform](#provider\_terraform) | n/a |
52-
=======
53-
=======
54-
>>>>>>> 8386d6c (all docs needs pass over)
55-
| Name | Version |
56-
| ------------------------------------------------ | ------- |
57-
| <a name="provider_aws"></a> [aws](#provider_aws) | n/a |
58-
59-
## Modules
60-
61-
No modules.
62-
=======
6345
```hcl
6446
module "example" {
6547
source = "<module-path>"
@@ -71,7 +53,6 @@ module "example" {
7153
owner =
7254
}
7355
```
74-
>>>>>>> 68471b8 (updated docs)
7556

7657
## Resources
7758

‎infrastructure/modules/cloudfront/README.md‎

Lines changed: 3 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -33,50 +33,9 @@ module "cloudfront" {
3333
<!-- BEGIN_TF_DOCS -->
3434
## Requirements
3535

36-
<<<<<<< HEAD
37-
## Requirements
38-
39-
| Name | Version |
40-
| ------------------------------------------------------ | ------- |
41-
| <a name="requirement_aws"></a> [aws](#requirement_aws) | ~> 5.0 |
42-
43-
## Providers
44-
45-
| Name | Version |
46-
| ------------------------------------------------ | ------- |
47-
| <a name="provider_aws"></a> [aws](#provider_aws) | ~> 5.0 |
48-
49-
## Modules
50-
51-
No modules.
52-
53-
## Resources
54-
55-
| Name | Type |
56-
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
57-
| [aws_cloudfront_cache_policy.nocache](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudfront_cache_policy) | resource |
58-
| [aws_cloudfront_distribution.distribution](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudfront_distribution) | resource |
59-
| [aws_cloudfront_origin_access_control.cloudfront_s3_oac](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudfront_origin_access_control) | resource |
60-
| [aws_cloudfront_origin_request_policy.viewer_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudfront_origin_request_policy) | resource |
61-
62-
## Inputs
63-
64-
| Name | Description | Type | Default | Required |
65-
| --------------------------------------------------------------------------------------- | ------------------------------------------------------ | -------- | ------- | :------: |
66-
| <a name="input_bucket_domain_name"></a> [bucket_domain_name](#input_bucket_domain_name) | Domain name to assign CloudFront distribution to | `string` | n/a | yes |
67-
| <a name="input_bucket_id"></a> [bucket_id](#input_bucket_id) | Bucket ID to assign CloudFront distribution to | `string` | n/a | yes |
68-
| <a name="input_qualifed_arn"></a> [qualifed_arn](#input_qualifed_arn) | Lambda@Edge function association | `string` | n/a | yes |
69-
| <a name="input_web_acl_id"></a> [web_acl_id](#input_web_acl_id) | Web ACL to associate this Cloudfront distribution with | `string` | `""` | no |
70-
71-
## Outputs
72-
73-
| Name | Description |
74-
| ----------------------------------------------------------------------------- | -------------------------------------- |
75-
| <a name="output_cloudfront_arn"></a> [cloudfront_arn](#output_cloudfront_arn) | The ARN of the CloudFront Distribution |
76-
| <a name="output_cloudfront_url"></a> [cloudfront_url](#output_cloudfront_url) | n/a |
77-
78-
=======
79-
No requirements.
36+
| Name | Version |
37+
|------|---------|
38+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.0 |
8039

8140
## Usage
8241
Basic usage of this module is as follows:
@@ -117,5 +76,4 @@ module "example" {
11776
|------|-------------|
11877
| <a name="output_cloudfront_arn"></a> [cloudfront\_arn](#output\_cloudfront\_arn) | The ARN of the CloudFront Distribution |
11978
| <a name="output_cloudfront_url"></a> [cloudfront\_url](#output\_cloudfront\_url) | n/a |
120-
>>>>>>> 68471b8 (updated docs)
12179
<!-- END_TF_DOCS -->

‎infrastructure/modules/dynamo_db/README.md‎

Lines changed: 3 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -81,64 +81,9 @@ module "document_reference_dynamodb_table" {
8181
<!-- BEGIN_TF_DOCS -->
8282
## Requirements
8383

84-
<<<<<<< HEAD
85-
## Requirements
86-
87-
| Name | Version |
88-
| ------------------------------------------------------ | ------- |
89-
| <a name="requirement_aws"></a> [aws](#requirement_aws) | ~> 5.0 |
90-
91-
## Providers
92-
93-
| Name | Version |
94-
| ------------------------------------------------ | ------- |
95-
| <a name="provider_aws"></a> [aws](#provider_aws) | ~> 5.0 |
96-
97-
## Modules
98-
99-
No modules.
100-
101-
## Resources
102-
103-
| Name | Type |
104-
| --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
105-
| [aws_dynamodb_table.ndr_dynamodb_table](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dynamodb_table) | resource |
106-
| [aws_iam_policy.dynamodb_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
107-
| [aws_iam_policy_document.dynamodb_read_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
108-
| [aws_iam_policy_document.dynamodb_write_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
109-
110-
## Inputs
111-
112-
| Name | Description | Type | Default | Required |
113-
| --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | ------------------- | ---------------------- | :------: |
114-
| <a name="input_attributes"></a> [attributes](#input_attributes) | List of nested attribute definitions | `list(map(string))` | `[]` | no |
115-
| <a name="input_billing_mode"></a> [billing_mode](#input_billing_mode) | n/a | `string` | `"PAY_PER_REQUEST"` | no |
116-
| <a name="input_deletion_protection_enabled"></a> [deletion_protection_enabled](#input_deletion_protection_enabled) | n/a | `bool` | `null` | no |
117-
| <a name="input_environment"></a> [environment](#input_environment) | n/a | `string` | n/a | yes |
118-
| <a name="input_global_secondary_indexes"></a> [global_secondary_indexes](#input_global_secondary_indexes) | n/a | `any` | `[]` | no |
119-
| <a name="input_hash_key"></a> [hash_key](#input_hash_key) | n/a | `string` | `null` | no |
120-
| <a name="input_owner"></a> [owner](#input_owner) | n/a | `string` | n/a | yes |
121-
| <a name="input_point_in_time_recovery_enabled"></a> [point_in_time_recovery_enabled](#input_point_in_time_recovery_enabled) | n/a | `bool` | `false` | no |
122-
| <a name="input_sort_key"></a> [sort_key](#input_sort_key) | n/a | `string` | `null` | no |
123-
| <a name="input_stream_enabled"></a> [stream_enabled](#input_stream_enabled) | n/a | `bool` | `false` | no |
124-
| <a name="input_stream_view_type"></a> [stream_view_type](#input_stream_view_type) | n/a | `string` | `"NEW_AND_OLD_IMAGES"` | no |
125-
| <a name="input_table_name"></a> [table_name](#input_table_name) | Name of the DynamoDB table | `string` | `null` | no |
126-
| <a name="input_ttl_attribute_name"></a> [ttl_attribute_name](#input_ttl_attribute_name) | n/a | `string` | `""` | no |
127-
| <a name="input_ttl_enabled"></a> [ttl_enabled](#input_ttl_enabled) | n/a | `bool` | `false` | no |
128-
129-
## Outputs
130-
131-
| Name | Description |
132-
| ----------------------------------------------------------------------------------------------------------------------------- | ----------- |
133-
| <a name="output_dynamodb_policy"></a> [dynamodb_policy](#output_dynamodb_policy) | n/a |
134-
| <a name="output_dynamodb_read_policy_document"></a> [dynamodb_read_policy_document](#output_dynamodb_read_policy_document) | n/a |
135-
| <a name="output_dynamodb_stream_arn"></a> [dynamodb_stream_arn](#output_dynamodb_stream_arn) | n/a |
136-
| <a name="output_dynamodb_table_arn"></a> [dynamodb_table_arn](#output_dynamodb_table_arn) | n/a |
137-
| <a name="output_dynamodb_write_policy_document"></a> [dynamodb_write_policy_document](#output_dynamodb_write_policy_document) | n/a |
138-
| <a name="output_table_name"></a> [table_name](#output_table_name) | n/a |
139-
140-
=======
141-
No requirements.
84+
| Name | Version |
85+
|------|---------|
86+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.0 |
14287

14388
## Usage
14489
Basic usage of this module is as follows:
@@ -203,5 +148,4 @@ module "example" {
203148
| <a name="output_dynamodb_table_arn"></a> [dynamodb\_table\_arn](#output\_dynamodb\_table\_arn) | n/a |
204149
| <a name="output_dynamodb_write_policy_document"></a> [dynamodb\_write\_policy\_document](#output\_dynamodb\_write\_policy\_document) | n/a |
205150
| <a name="output_table_name"></a> [table\_name](#output\_table\_name) | n/a |
206-
>>>>>>> 68471b8 (updated docs)
207151
<!-- END_TF_DOCS -->

‎infrastructure/modules/ecr/README.md‎

Lines changed: 3 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -35,48 +35,9 @@ module "ecr_repository" {
3535
<!-- BEGIN_TF_DOCS -->
3636
## Requirements
3737

38-
<<<<<<< HEAD
39-
## Requirements
40-
41-
| Name | Version |
42-
| ------------------------------------------------------ | ------- |
43-
| <a name="requirement_aws"></a> [aws](#requirement_aws) | ~> 5.0 |
44-
45-
## Providers
46-
47-
| Name | Version |
48-
| ------------------------------------------------ | ------- |
49-
| <a name="provider_aws"></a> [aws](#provider_aws) | ~> 5.0 |
50-
51-
## Modules
52-
53-
No modules.
54-
55-
## Resources
56-
57-
| Name | Type |
58-
| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
59-
| [aws_ecr_lifecycle_policy.ndr_ecr_lifecycle_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecr_lifecycle_policy) | resource |
60-
| [aws_ecr_repository.ndr-ecr](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecr_repository) | resource |
61-
| [aws_ecr_repository_policy.ndr_ecr_repository_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecr_repository_policy) | resource |
62-
63-
## Inputs
64-
65-
| Name | Description | Type | Default | Required |
66-
| --------------------------------------------------------------------------------------- | ------------------- | -------- | ------- | :------: |
67-
| <a name="input_app_name"></a> [app_name](#input_app_name) | the name of the app | `string` | n/a | yes |
68-
| <a name="input_current_account_id"></a> [current_account_id](#input_current_account_id) | n/a | `string` | n/a | yes |
69-
| <a name="input_environment"></a> [environment](#input_environment) | n/a | `string` | n/a | yes |
70-
| <a name="input_owner"></a> [owner](#input_owner) | n/a | `string` | n/a | yes |
71-
72-
## Outputs
73-
74-
| Name | Description |
75-
| ----------------------------------------------------------------------------------------- | ----------- |
76-
| <a name="output_ecr_repository_url"></a> [ecr_repository_url](#output_ecr_repository_url) | n/a |
77-
78-
=======
79-
No requirements.
38+
| Name | Version |
39+
|------|---------|
40+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 5.0 |
8041

8142
## Usage
8243
Basic usage of this module is as follows:
@@ -113,5 +74,4 @@ module "example" {
11374
| Name | Description |
11475
|------|-------------|
11576
| <a name="output_ecr_repository_url"></a> [ecr\_repository\_url](#output\_ecr\_repository\_url) | n/a |
116-
>>>>>>> 68471b8 (updated docs)
11777
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)