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.

Sign up for GitHub

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

Jump to bottom

[Docs]: Enhance the aws_rds_cluster_endpoint documentation (https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/rds_cluster_endpoint) by indicating that this resource is related to Aurora custom endpoints. #37183

Closed
MykKuc opened this issue Apr 30, 2024 · 4 comments · Fixed by #38089
Closed

[Docs]: Enhance the aws_rds_cluster_endpoint documentation (https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/rds_cluster_endpoint) by indicating that this resource is related to Aurora custom endpoints. #37183

MykKuc opened this issue Apr 30, 2024 · 4 comments · Fixed by #38089
Labels
documentation Introduces or discusses updates to documentation. service/rds Issues and PRs that pertain to the rds service.
Milestone
v5.56.0

Comments

@MykKuc
Copy link

MykKuc commented Apr 30, 2024 •
edited
Loading

Documentation Link

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/rds_cluster_endpoint

Description

This is more of a documentation enhancement. In the intro section of documentation ("Manages an RDS Aurora Cluster Endpoint.") I would suggest indicating in some way that this is a resource related to Aurora custom endpoints. Because right now "Aurora Cluster Endpoint" might be a little confusing for newer people who are not familiar with Aurora endpoints. According to AWS documentation (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html) there can be "cluster" and "custom" endpoint types. From the section one might think this is related to "cluster" endpoint type and not "custom" endpoint type.

I suggest changing it to "Manages an RDS Aurora Cluster Custom Endpoint" so it is more clearer.

References

https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html

Would you like to implement a fix?

No
@MykKuc MykKuc added the documentation Introduces or discusses updates to documentation. label Apr 30, 2024
@github-actions GitHub Actions
Copy link

Community Note

Voting for Prioritization

  • Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

  • If you are interested in working on this issue, please leave a comment.
  • If this would be your first contribution, please review the contribution guide.

@terraform-aws-provider terraform-aws-provider bot added the needs-triage Waiting for first response or review from a maintainer. label Apr 30, 2024
@rama280290
Copy link
Contributor

I will work on this documentation update and raise PR

@rama280290 rama280290 mentioned this issue Jun 24, 2024
Merged
@ewbankkit ewbankkit added service/rds Issues and PRs that pertain to the rds service. and removed needs-triage Waiting for first response or review from a maintainer. labels Jun 24, 2024
@github-actions GitHub Actions
Copy link

Warning

This issue has been closed, meaning that any additional comments are hard for our team to see. Please assume that the maintainers will not see them.

Ongoing conversations amongst community members are welcome, however, the issue will be locked after 30 days. Moving conversations to another venue, such as the AWS Provider forum, is recommended. If you have additional concerns, please open a new issue, referencing this one where needed.

@github-actions github-actions bot added this to the v5.56.0 milestone Jun 24, 2024
@github-actions GitHub Actions
Copy link

This functionality has been released in v5.56.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Introduces or discusses updates to documentation. service/rds Issues and PRs that pertain to the rds service.
Projects
None yet
Milestone
v5.56.0
Development

Successfully merging a pull request may close this issue.

Update rds_cluster_endpoint.html.markdown fidelity-contributions/hashicorp-terraform-provider-aws
3 participants
@ewbankkit @MykKuc @rama280290