add module naming convention

[migara]

Description

Documentation update

[damianfedeczko]

Suggested change

	Examples
	Examples:

[damianfedeczko]

Suggested change

	Module structure:

[damianfedeczko]

Veeery minor suggestions + linter failed 🥳

[jabielecki]

I'd be against. We have so many modules named with snake_case. Renaming all of them is a big change, so I'd wonder what strong arguments are there?

ls ../terraform-*/modules
../terraform-aws-vmseries-modules/modules:
asg  bootstrap  crosszone_failover  gwlb  panorama  transit_gateway  vmseries  vpc  vpc_endpoint  vpc_routes

../terraform-google-vmseries-modules/modules:
autoscale  bootstrap  gcp_bootstrap  iam_service_account  lb_http_ext_global  lb_tcp_external  lb_tcp_internal  panorama  vm  vmseries  vpc

When programming, there is a temptation to first do use the identical string:

module "security-group" { # <-- copy pasted from `source`
  source  = "terraform-aws-modules/security-group/aws"
  version = "4.0.0"
}

This either fails the linting rule after some time, or if uncaught, it leads to this painful experience:

id = module.security-group.security_group.sg_id

Subjectively I know the excerpts like the previous line hurt my productivity a lot. But I know it won't be the same for all of us.

(Introducing a long-existing inconsistency is worse. In usage, if a dev or user is always in doubt whether this time it's transit-gateway or transit_gateway, that sums up over all these people to quite a noticeable problem.)

[devsecfranklin]

I think this is the name of the main module, rather than changing every variable name. I could be wrong though. Care to comment @migara ?

[devsecfranklin]

Got a few linter errors it looks like:

README.md: 456: MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Module naming convention"]
README.md: 460: MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
README.md: 460: MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
README.md: 460: MD046/code-block-style Code block style [Expected: indented; Actual: fenced]

[devsecfranklin]

few linter errors but LGTM overall