Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate to README.yaml format #19

Merged
merged 3 commits into from
Jul 11, 2018
Merged

Migrate to README.yaml format #19

merged 3 commits into from
Jul 11, 2018

Conversation

vadim-gleif
Copy link
Contributor

what

  • Add README.yaml

why

  • Standardize README

@vadim-gleif vadim-gleif requested a review from osterman July 4, 2018 14:17
sarkis
sarkis previously requested changes Jul 4, 2018
outputs.tf Outdated
}

output "cf_arn" {
value = "${aws_cloudfront_distribution.default.arn}"
value = "${aws_cloudfront_distribution.default.arn}"
description = "ID of AWS CloudFront distribution"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ARN of AWS CloudFront distribution

variables.tf Outdated
@@ -32,7 +32,8 @@ variable "tags" {
}

variable "enabled" {
default = "true"
default = "true"
description = "State of CloudFront"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Boolean which determines if CloudFront resources are created

variables.tf Outdated
default = ["*"]
type = "list"
default = ["*"]
description = "List of allowed headers for S3 bucket"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unneeded extra space between words headers and for

variables.tf Outdated
default = ["GET"]
type = "list"
default = ["GET"]
description = "List of allowed methods (e.g. ` GET, PUT, POST, DELETE, HEAD`) for S3 bucket"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need the backtick here? If so maybe we should do e.g. GET, PUT, ...

variables.tf Outdated
default = []
type = "list"
default = []
description = "List of allowed origins (e.g. ` example.com, test.com`) for S3 bucket"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need the ` here?

variables.tf Outdated
default = ["DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"]
type = "list"
default = ["DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT"]
description = "List of allowed methods (e.g. ` GET, PUT, POST, DELETE, HEAD`) for AWS CloudFront"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need the ` here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yea, let's just remove the back tick

variables.tf Outdated
default = ["GET", "HEAD"]
type = "list"
default = ["GET", "HEAD"]
description = "List of cached methods (e.g. ` GET, PUT, POST, DELETE, HEAD`)"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need the ` here?

@osterman osterman dismissed sarkis’s stale review July 11, 2018 21:58

Comments addressed

@osterman osterman merged commit f8ab489 into master Jul 11, 2018
@osterman osterman deleted the migrate-readme-yaml branch July 11, 2018 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants