Formatting the provider to use terraform-plugin-docs

[faithlum]

trafficstars

Description

Formatting provider to transition from manual markdown editing to using tfplugindocs for registry doc generation.

The followup PR #603 contains a guide script to help contributors prepare the necessary assets for creating new docs and run the tfplugindocs command.

More Info

• My lightning talk recording (3:00-10:00) has quick overview of what is tfplugindocs and the goal of this project.
• Directory "info-project-docsparkle" on the "docsparkle/scripts" also contains more info on the tool and details to be aware of.

Summary of Changes (listed by directory)

1. tfe

• resource/datasource descriptions defined in resource schema
• attribute descriptions defined in resource schema

2. examples

• code snippets for "example usage" section organized in specific subdirectories

3. templates

• .md.tmpl used to generate markdown files
• general fallback templates exist for resources and data-sources
• custom templates exist for any that require additional sections beyond fallback

4. docs

• automatically generated markdown after running tfplugindocs command
• should never be directly edited

Testing plan

1. install tfplugindocs
2. run tfplugindocs command
3. check the docs directory for generated .md
4. paste markdown in docs preview tool to see how it will appear on the website

[hashicorp-cla]

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes

_{Have you signed the CLA already but the status is still pending? Recheck it.}

[brandonc]

Converted to draft until the work to support is prioritized

[annawinkler]

Thank you for the PR! Closing because we aren't moving forward with this work.