Skip to content

docs: fix 13 README typos, including invalid HCL in the usage examples - #48

Open
Avicennasis wants to merge 1 commit into
Capgemini:masterfrom
Avicennasis:docs/fix-typos
Open

docs: fix 13 README typos, including invalid HCL in the usage examples#48
Avicennasis wants to merge 1 commit into
Capgemini:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

Summary

Fix 13 typos across the module READMEs, including four that make the copy-pasteable Terraform examples invalid.

Broken example code

  • kubernetes/README.md (x2) and etcd/README.md (x1): early_renewal_hours" = "720" -> early_renewal_hours = "720"
  • kubernetes/README.md (x2): ssh_private_key" = "/ssh/private_key" -> ssh_private_key = "/ssh/private_key"

A stray double quote after the attribute name makes these module blocks fail to parse if copied as-is. The = alignment of the surrounding block is preserved.

Incorrect variable documentation

  • docker/README.md: `ip_addresses_list` - List of DNS names for which a certificate is being requested. -> List of IP addresses ...

ip_addresses_list feeds ip_addresses in docker/daemon/main.tf; the module has a separate dns_names_list variable for dns_names, so this description had been copy-pasted from the wrong variable.

Prose

  • README.md: TLS certs etcd -> TLS certs for etcd (matches the neighbouring catalog bullets)
  • docker/README.md: connect to yor docker daemon -> your docker daemon
  • docker/README.md: Assuming you docker daemon is configured -> Assuming your docker daemon
  • docker/README.md: test it from on of the clients -> from one of the clients
  • kubernetes/README.md and etcd/README.md: A terraform module with contains TLS certificates -> which contains
  • ca/README.md: Folder to upload the the CA. -> Folder to upload the CA.

Documentation only - no .tf files were modified.

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.

1 participant