hashicorp / hashicorp/terraform-plugin-docs
Add information about update-ability, default value, & validation
- Dominant language
- Go
- Stars
- 263
- Forks
- 84
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 2
Description
### Terraform CLI and terraform-plugin-docs Versions
latest
### Use Cases or Problem Statement
It would be nice for users to know more about a parameters behaviors without having to write lengthy custom descriptions. It would also be nice to be able to have a unified look to documentation so common questions are answered uniformly and generated instead of hand typed.
Specifically it would be nice to know a parameters:
- default value - if applicable
- updateability - if it can be updated or requires replacement
- validators - what types of validations are run against the input
### Proposal
Technical implementation is currently limited by missing fields in the [schema](https://github.com/hashicorp/terraform/issues/35646). That aside, here are some proposals for how to display the information:
```markdown
- `my_parameter`:
- Type:
- Default: "one"
- Plan Modifiers:
- Forces Recreation
- Validators:
- Any one of: `one`, `two`, `three`
```
### How much impact is this issue causing?
Low
### Additional Information
_No response_
### Code of Conduct
- [X] I agree to follow this project's Code of Conduct
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.