hashicorp / hashicorp/terraform-plugin-docs

Stronger emphasis on `Deprecated` schema fields

Open
#34 2 comments 4 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
263
Forks
84
Avg merge
3d 6h
Merged PRs (30d)
2

Description

Currently, when a field in a schema is deprecated, it shows up in parenthesis next to whether it's required or not.

Live example here under `thresholds` - https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/monitor#optional

```
thresholds (Map of String, Deprecated) Alert thresholds of the monitor.
```

Could the fact that a field is deprecated be more strongly represented?
A few ideas for this may be -
* Make the word `Deprecated` bold to stand out more
* Maybe have a new section `Required`, `Optional`, `Deprecated`

Thanks for this project 🙂

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.