feat/doc generation

[mavogel]

Details

• enables the generation of the documentation from the descriptions within the schema based on https://github.com/hashicorp/terraform-plugin-docs
• there are still bugs/missing features
  • for rendering nested resources in data-source. See bug: TypeSet/TypeList Elements are not rendered in data-sources hashicorp/terraform-plugin-docs#64
  • for default values: feat: add default values to attributes to documentation hashicorp/terraform-plugin-docs#65
  • for rendering read-only blocks: bug: attribute descriptions are not rendered in read-only nested block hashicorp/terraform-plugin-docs#66

TODOs

• add all descriptions for the attributes
• how many attributes are required for datasources?
• customize all templates to make descriptions more concise
• read through all docs if they make sense and are understandable

Questions:

• do we still need the link check for markdown? -> fixed rules in fb33652

[suzuki-shunsuke]

How about running make website-generation and checking if there is any change in CI?

[suzuki-shunsuke]

Thank you for your great work ❤️

[mavogel]

@suzuki-shunsuke thanks for the hint. Added it! Take a look at the latest build/action