terraform-provider-tfe icon indicating copy to clipboard operation
terraform-provider-tfe copied to clipboard

Guide script to use terraform-plugin-docs

Open faithlum opened this issue 3 years ago • 2 comments

Description

A guide script for contributors to add/edit docs on the Registry website.

What does it do? Walks users through preparing the required templates and examples before running the tfplugindocs command to generate markdown

When to use? When users add new resources/data sources or edit pre-existing ones that require doc changes to attribute descriptions, examples, and import statements.

How to use? Github PR template will include a reminder to run the script locally after making any relevant changes to the "tfe" directory files.

Testing plan

  1. Go into "scripts/menu-scripts" directory
  2. Run ./1-main-menu.sh to open script menu and follow steps
  3. Check the "docs" directory for the markdown files corresponding to your resource
  4. Paste the .md file in the Registry Docs Preview Tool and compare how the preview looks to the existing Registry page (please comment any feedback)

In addition, if you selected the CUSTOM route, check:

  • "templates" directory for the .tmpl file corresponding to your resource

faithlum avatar Aug 16 '22 16:08 faithlum

CLA assistant check

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.

hashicorp-cla avatar Aug 16 '22 16:08 hashicorp-cla

✨ This is exciting work! Thank you! I have a few high-level suggestions:

  • ⭐ Please squash your commits so there is one commit
  • 📝 It would be helpful to have docs on how to run the script such as a section in the Contributing guide

annawinkler avatar Aug 17 '22 15:08 annawinkler

Converted to draft until the work to complete this is prioritized

brandonc avatar Feb 02 '23 18:02 brandonc

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

annawinkler avatar May 22 '23 14:05 annawinkler