Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Terraform documentation wrong hyperlinking for service_perimeter #18913

Open
anilkumarmyla opened this issue Jul 30, 2024 · 3 comments
Open

Terraform documentation wrong hyperlinking for service_perimeter #18913

anilkumarmyla opened this issue Jul 30, 2024 · 3 comments
Labels
documentation forward/exempt Never forward this issue mmv1-generator Provider-wide changes to resource templates or other generator changes service/terraform upstream-terraform

Comments

@anilkumarmyla
Copy link

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request.
  • Please do not leave +1 or me too comments, they generate extra noise for issue followers and do not help prioritize the request.
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment.
  • If an issue is assigned to a user, that user is claiming responsibility for the issue.
  • Customers working with a Google Technical Account Manager or Customer Engineer can ask them to reach out internally to expedite investigation and resolution of this issue.

Terraform Version & Provider Version(s)

latest versions
Terraform vX.X.X
on

  • provider registry.terraform.io/hashicorp/google vX.X.X
  • provider registry.terraform.io/hashicorp/google-beta vX.X.X

Affected Resource(s)

google_access_context_manager_service_perimeter

Terraform Configuration

Debug Output

No response

Expected Behavior

On this page https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/access_context_manager_service_perimeter#nested_egress_from

From egress_policies > egress_from > sources, if you click 'sources' or its structure hyperlink it directs to ingress_from sources which is slighly different from egress_from sources. This hyperlink should be fixed.

Actual Behavior

No response

Steps to reproduce

  1. terraform apply

Important Factoids

No response

References

No response

@github-actions github-actions bot added forward/review In review; remove label to forward service/accesscontextmanager labels Jul 30, 2024
@ggtisc ggtisc self-assigned this Aug 9, 2024
@ggtisc
Copy link
Collaborator

ggtisc commented Aug 9, 2024

Hi @anilkumarmyla

It looks like it's fixed, please try again. If you continue having issues, do basic troubleshooting like restarting your browser, try with another browser, change your screen-browser-configurattion, clean cache, cookies, etc.

@anilkumarmyla
Copy link
Author

anilkumarmyla commented Aug 9, 2024

It looks like it's fixed, please try again.

Nope, is there a commit that can be referenced for this fix?

If you continue having issues, do basic troubleshooting like restarting your browser, try with another browser, change your screen-browser-configurattion, clean cache, cookies, etc.

Come on now, this is not a browser issue

@roaks3
Copy link
Collaborator

roaks3 commented Aug 12, 2024

Following up with a look at the code, this is a systemic issue that has been present for a long time (since GoogleCloudPlatform/magic-modules#5192). For another example, see the encryption_config link under https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/alloydb_cluster#nested_continuous_backup_config.

Basically, our logic for generated docs does not consider the parent of the field, so when there are duplicate field names anywhere within the schema, this can occur.

An ideal solution would probably include the parent field(s) in the anchor, but I think that solution would break existing links that are being used. To preserve current links while fixing the issue, we may need to somehow modify the anchors used by all but the first occurrence (eg. nested_source, nested_sources2, etc.).

@roaks3 roaks3 added service/terraform forward/exempt Never forward this issue documentation mmv1-generator Provider-wide changes to resource templates or other generator changes and removed service/accesscontextmanager forward/review In review; remove label to forward bug labels Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation forward/exempt Never forward this issue mmv1-generator Provider-wide changes to resource templates or other generator changes service/terraform upstream-terraform
Projects
None yet
Development

No branches or pull requests

4 participants