Use Linter to check the terraform code and update the docs

[serdardalgic]

We need to set up a mechanism to terraform fmt the code, and also go generate the docs and the examples.
We can set up a pre-commit hook so that the developers/contributers can check their code.

Even better, we can automate this system, such as https://terraform-docs.io/how-to/github-action/

[serdardalgic]

Copying this comment @nstott here:

before we publish the provider, I think we should

• automate the doc generation
• linters
• check the doc text associated with the different properties to catch typos, bad copy pasta, etc
• add examples

[serdardalgic]

I think we can group the linters in such categories:

• Automated doc generation and terraform fmt check (can be addressed via https://terraform-docs.io/how-to/github-action/ )
• A conventional commit check. (e.g. https://github.com/marketplace/actions/conventional-commit-checker)
• Non-inclusive and intrusive language check and typo check.
• Naming convention check, to enforce the naming convention mentioned in the CONTRIBUTING.md file.

For the naming and best-practice check, We can check https://github.com/terraform-linters/tflint.

[serdardalgic]

I'd like to tear down this issue into smaller pieces:

I created a new issue for

• For automated doc generation GH workflow for docs generation #55
• Naming convention check Naming convention checker GH action #56

The following checkers are addressed with PRs

• A conventional commit check has been merged in chore: Conventional commit checker GH action #49
• Non-inclusive language detector and spellchecker will be merged in ci: Spellcheck GH action #50

After #50 is merged, I think we can close this ticket.