feat(cli): Add inline doc links to Terraform provider docs when generating provider bindings #576
Conversation
skorfmann
changed the title
|
For Python, it looks like this - the formatting is not properly transformed, but the link would be usable nevertheless. Not sure if there's a way to make appearance better.
The wording for data sources doesn't really make sense. Gonna change that. |
That's the same for AWS CDK, hence I'm assuming there's no jsdoc transforming in jsii |
This links to an anchor fragment, which are not properly set in all provider docs (e.g. Docker). But it seems to work for the majority of popular providers.
|
a504733 adds direct links to the attribute of resource in the Terraform Registry. It seems to work for the majority of the popular providers. 🎉
|
Changed that slightly. |
|
Java looks pretty good as well
|
|
Go seems to pick up the resource level link, but not the attribute level ones. But that's close enough for now. |
|
csharp works as well 🎉
|
packages/cdktf-cli/lib/get/generator/emitter/resource-emitter.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Ansgar Mertens <[email protected]>
|
This is awesome 💯 |
|
I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues. If you've found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
This adds jsdoc links to generated resources / data sources for a provider.
The url which we're using seems to be deprecated. There are redirects in place, so it's not a big issue right now. However, it should be addressed at some point. the new url structure expects the namespace to be present (something like
hashicorp/aws).This could be easily extend to attribute level anchor links to the Terraform registry. Something like
https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dynamodb_table#nameTodo: