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 in resources index: s/Read/Delete/ #482

Merged
merged 2 commits into from Sep 14, 2022

Conversation

PChambino
Copy link
Contributor

When reading the documentation on the website while preparing to migrate an existing small-ish provider, I noticed this typo which seems like it was introduced two days ago (7541ab1).

I was expecting to find a Delete function in that example and ended up scrolling up and down for a couple of minutes until I realised there was a typo in the function name.

I did notice the contribution guidelines indicate that typo PR aren't generally accepted, but hopefully this one is more than an innocent typo since it can really confuse people reading the documentation expecting to find a Delete function in that first overview example. If not, I am sorry for the noise.

@PChambino PChambino requested a review from a team as a code owner September 14, 2022 09:39
@hashicorp-cla
Copy link

hashicorp-cla commented Sep 14, 2022

CLA assistant check
All committers have signed the CLA.

Copy link
Member

@bflad bflad left a comment

Choose a reason for hiding this comment

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

Hi @PChambino 👋 Thank you for finding this and submitting a fix, we'll also need to update the other parameter to match the correct method name, but otherwise we really appreciate this. Thanks again.

website/docs/plugin/framework/resources/index.mdx Outdated Show resolved Hide resolved
@bflad bflad added this to the v0.13.0 milestone Sep 14, 2022
@bflad bflad added the documentation Improvements or additions to documentation label Sep 14, 2022
@bflad bflad merged commit d974925 into hashicorp:main Sep 14, 2022
@PChambino PChambino deleted the patch-1 branch September 16, 2022 02:10
@github-actions
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 contributions.
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 Oct 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants