Comments (2)
paultyng
commented on June 13, 2024
I agree this would be great to include, unfortunately deprecation messages are not included in the schema exported from Terraform, only a bool indicating its deprecated. Your best bet would be customize the description (or description generator) for a resource, see the ResourceDescriptionBuilder in the SDK to hook the generated description and append that message.
Scaffolding has an example of how to do similar for defaults on attributes: https://github.com/hashicorp/terraform-provider-scaffolding/blob/bec212504f3fc7ad42e5f3a80425cb95872dda28/internal/provider/provider.go#L15-L23
from terraform-plugin-docs.
paultyng
commented on June 13, 2024
Going to close this since there isn't a way to achieve it in the generator, but happy to include an example on the scaffolding repo and link to it to solve this for folks.
from terraform-plugin-docs.
Related Issues (20)
- Error executing command: unable to generate website: unexpected error: openpgp: signature made by unknown entity HOT 1
- `v0.14.0` causes unrelated provider acceptance failures HOT 1
- Bump Expected Minimum Go Version to 1.19 HOT 1
- Data source output markdown file missing example usage subsection HOT 3
- Add validator docstrings to params for providers using terraform-plugin-framework HOT 1
- Error when resource schema element has a default value with double curly braces HOT 4
- Errors when using plugin mux with plugin sdk and framework HOT 1
- Show default values for supported timeouts HOT 5
- Hide specific config options in the docs HOT 2
- Resource schema documentation generation ignores property values HOT 2
- SchemaMarkdown contains wrong nested attribute titles
- Consider Warning/Error With Mismatched Terraform Architecture HOT 11
- Support Provider-Defined Function Documentation HOT 3
- Migrate from mitchellh/cli to hashicorp/cli HOT 1
- Bug: generate fails with "Provider registry.terraform.io/hashicorp/mongodbatlas v0.0.1 does not have a package available for your current platform, darwin_arm64." HOT 6
- Switch to `github.com/yuin/goldmark` library for all Markdown processing HOT 1
- [Question] Why do we have to provide the `--tf-version` to the `generate` command? HOT 2
- tfplugindocs migrate command outputs absolute file paths HOT 1
- Add a GitHub Action tutorial
- Improve documentation of `object` type for provider-defined functions
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from terraform-plugin-docs.