Multiple attribute/arguments with same name appear to be linked incorrectly
kriswuollett opened this issue · 1 comments
Originally filed at hashicorp/terraform-provider-kubernetes#1543 but I think the issue is here?
The doc link for resources/deployment spec.template.spec
points back to top-level #spec
not #template-spec
. It seems like the links are generated automatically since I don't see an explicit anchor link for it, e.g., * ``spec`` - (Required) Specification of...
. When combined with all elements being leading edge justified --- no depth from hierarchy visually apparent -- it could lead to unknowingly reading the wrong documentation for a section.
I'm guessing the link generation does not work for non-unique nested identifiers?
Affected Resource(s)
The deployment
docs for sure, but I assume the core issue affects all resource documentation.
Expected Behavior
The registry documentation should be able to point to a nested type of the same name.
Actual Behavior
Link for a child attribute with the same name will go to previously defined one of the same name if it exists?
Hi @kriswuollett! Thank you for reporting this. It looks like this impacts registry.terraform.io
, which doesn't live in this repo. We don't have a public issue tracker for the registry, but I've gone ahead and filed an internal ticket with the relevant team. Since this doesn't affect terraform.io
, I'm going to close the issue, but I'll be sure to share any updates I have here.