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

[docs] Typo fix in website docs #37047

Merged
merged 1 commit into from
Apr 23, 2024
Merged

Conversation

mbbush
Copy link
Contributor

@mbbush mbbush commented Apr 22, 2024

Description

Fix a typo in the documentation for r/aws_codecommit_repository

References

When the aws_codecommit_repository resource was enhanced to add the kms_key_id parameter in #35095, the documentation added for the new parameter had a typo in it, and closed the name of the fallback AWS-managed key with a double backtick `` instead of a single `.

This results in the name not rendering properly on the terraform provider registry website, and for some strange reason I haven't pinned down yet, only sometimes breaks a tool I use that parses the terraform provider documentation. I'll take care of fixing the tool, but I thought I'd open the PR to clean up the website.

The same typo is present in the cdktf docs, but it looks like the normal practice is for those to be updated by codegen scripts, not by humans. If I'm wrong about that I prepared 3a3dfd1 as well, but didn't open a PR.

Output from Acceptance Testing

I didn't run acceptance testing because it's only a documentation change.

Copy link

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull 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.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added size/XS Managed by automation to categorize the size of a PR. documentation Introduces or discusses updates to documentation. service/codecommit Issues and PRs that pertain to the codecommit service. labels Apr 22, 2024
@terraform-aws-provider terraform-aws-provider bot added the needs-triage Waiting for first response or review from a maintainer. label Apr 22, 2024
Copy link
Member

@justinretzolk justinretzolk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Thank you for taking the time to contribute the fix! I'll get this merged as soon as the checks finish up 🚀

@justinretzolk justinretzolk merged commit bd0c9f2 into hashicorp:main Apr 23, 2024
49 checks passed
@github-actions github-actions bot added this to the v5.47.0 milestone Apr 23, 2024
@terraform-aws-provider terraform-aws-provider bot removed the needs-triage Waiting for first response or review from a maintainer. label Apr 23, 2024
Copy link

This functionality has been released in v5.47.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!

Copy link

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 have 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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Introduces or discusses updates to documentation. service/codecommit Issues and PRs that pertain to the codecommit service. size/XS Managed by automation to categorize the size of a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants