hashicorp / hashicorp/terraform-docs-common

Add support for documentation generation in the tutorial

Open
#476 2 comments 0 reactions 0 assignees View on GitHub
documentation plugin
Dominant language
Makefile
Stars
36
Forks
133
PR merge metrics
No merged PRs in 30d

Description

In the tutorial about code generation: website/docs/plugin/code-generation/workflow-example.mdx

Could you add support about how to generate documentation as well? Maybe with https://github.com/terraform-docs/terraform-docs or something similar

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with website/docs/plugin/code-generation/workflow-example.mdx and review how the tutorial currently explains code generation. Compare the requested documentation-generation support with the linked terraform-docs project or a similar tool. Done means the tutorial explains how to generate documentation alongside the existing workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
terraform
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.