docs: fix 13 README typos, including invalid HCL in the usage examples - #48
Open
Avicennasis wants to merge 1 commit into
Open
docs: fix 13 README typos, including invalid HCL in the usage examples#48Avicennasis wants to merge 1 commit into
Avicennasis wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix 13 typos across the module READMEs, including four that make the copy-pasteable Terraform examples invalid.
Broken example code
early_renewal_hours" = "720"->early_renewal_hours = "720"ssh_private_key" = "/ssh/private_key"->ssh_private_key = "/ssh/private_key"A stray double quote after the attribute name makes these
moduleblocks fail to parse if copied as-is. The=alignment of the surrounding block is preserved.Incorrect variable documentation
`ip_addresses_list` - List of DNS names for which a certificate is being requested.->List of IP addresses ...ip_addresses_listfeedsip_addressesindocker/daemon/main.tf; the module has a separatedns_names_listvariable fordns_names, so this description had been copy-pasted from the wrong variable.Prose
TLS certs etcd->TLS certs for etcd(matches the neighbouring catalog bullets)connect to yor docker daemon->your docker daemonAssuming you docker daemon is configured->Assuming your docker daemontest it from on of the clients->from one of the clientsA terraform module with contains TLS certificates->which containsFolder to upload the the CA.->Folder to upload the CA.Documentation only - no
.tffiles were modified.