Fixed typos

[lzandman]

Fixed some typos I noticed.

[hashicorp-cla]

All committers have signed the CLA.

[lzandman]

Why does that validation step fail? Did I alter some files that I shouldn't have?

[lbajolet-hashicorp]

Hi @lzandman,

The files in .web-docs are generated from a combination of text in the docs directory, and partials extracted from the Go code documentation (packer-sdc is the component responsible for that).

So in this case yes, those changes you made to the files in .web-docs are overwritten by make generate, which we run in CI so we always have up-to-date documentation.

I suggest you run the command locally and search for the source of those typos in the code, if fixed here, the generation should stabilise.
Let me know if you need help!

Thanks for the patch.

[lzandman]

I'm not able to do a make generate on the system I currently work on. I did revert all files in the .web-docs folder.

[lbajolet-hashicorp]

Hi @lzandman,

Thanks for the update; I've taken the liberty to run make generate to update the .web-docs from your changes, hopefully the CI should be green.

If it succeeds, I'll merge the PR today.

Thanks again!

[lzandman]

Really weird how this PR's diff view still shows changed files in .web-docs. I'm pretty sure my branch doesn't. Is the build that's currently running (actions) generating those files and adding them to this PR?

In any case, I see all validations have been successfully passed!

[lbajolet-hashicorp]

Oh maybe I wasn't explicit when I commented sorry about that.

Everything in .web-docs is versioned, the documentation for the plugin is extracted from this directory.
We have a check in our pipelines for making sure the .web-docs generated data is up-to-date compared to the code (since comments are extracted as partials), and if there's a discrepancy between what was committed and what is generated in CI, this means that the .web-docs should be generated and committed to git.

Hope that clears-up that misunderstanding!

[lzandman]

Ah, I understand.

[lbajolet-hashicorp]

LGTM!