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

doc: fix minor typo #289

Merged
merged 1 commit into from
Nov 22, 2024
Merged

doc: fix minor typo #289

merged 1 commit into from
Nov 22, 2024

Conversation

ahamez
Copy link
Contributor

@ahamez ahamez commented Nov 21, 2024

No description provided.

@ahamez ahamez requested a review from a team as a code owner November 21, 2024 16:55
@ahamez
Copy link
Contributor Author

ahamez commented Nov 21, 2024

🤔 Is there something I should do regarding the failing test?

@austinvalle
Copy link
Member

Hey there @ahamez 👋🏻 , thanks for the documentation fix!

So the reason the CI is failing is because our documentation is auto-generated from a different source of truth, which is here:

"This is not a generalized utility for producing multi-part MIME messages. It's feature set is specialized for cloud-init multi-part MIME messages.",

So for your change, you'd want to edit that Go file and then run make generate, which will regenerate our documentation in all places.

There's also a managed resource equivalent that has a similar grammatical error in a different Go file:

"This is not a generalized utility for producing multi-part MIME messages. It's feature set is specialized for cloud-init multi-part MIME messages.",


If you update your PR and regenerate the docs then it should be all green 👍🏻

Copy link
Member

@austinvalle austinvalle left a comment

Choose a reason for hiding this comment

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

Thanks again for the fix @ahamez! 🚀

@austinvalle austinvalle merged commit 52f4d7a into hashicorp:main Nov 22, 2024
4 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants