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

Documentation for data-source and post-processors is missing #147

Closed
khawarizmus opened this issue Jun 25, 2024 · 6 comments · Fixed by #149
Closed

Documentation for data-source and post-processors is missing #147

khawarizmus opened this issue Jun 25, 2024 · 6 comments · Fixed by #149
Labels

Comments

@khawarizmus
Copy link

Overview of the Issue

The documentation for the digitalocean-image data-source is broken.

Same behaviour for digitalocean-import post-processor

Reproduction Steps

Go to the documentation and check

@andrewsomething
Copy link
Member

Thanks for flagging this. The changes in #148 seemed to resolve this for the digitalocean-import post-processor:

https://developer.hashicorp.com/packer/integrations/digitalocean/digitalocean/latest/components/post-processor/digitalocean-import

Unfortunately it did not fix the data source. We'll continue to investigate.

@andrewsomething
Copy link
Member

@lbajolet-hashicorp Any chance you can help identify the issue here as you handled the initial migration? It's not clear to me why the post-processor docs are not getting picked up.

@lbajolet-hashicorp
Copy link
Contributor

Hi @andrewsomething,

Thanks for the ping. Looks like there's a typo in the name for the datasource, which is likely why the link won't work.

I've opened a PR to help fix this, hopefully that's all that's needed here!

@andrewsomething
Copy link
Member

Thanks @lbajolet-hashicorp! Stared at the contents of that file for so long without catching the typo in the name itself. 🤦‍♂️

@lbajolet-hashicorp
Copy link
Contributor

All good, been here done that :)

I'd suggest running the manual publish action on main now that the PR's been merged, this should hopefully fix that on the web docs

@andrewsomething
Copy link
Member

Confirmed that it now displays as expected:

https://developer.hashicorp.com/packer/integrations/digitalocean/digitalocean/latest/components/data-source/digitalocean-image

Thanks again @lbajolet-hashicorp!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants