-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
Add Nutanix plugin docs #12131
Add Nutanix plugin docs #12131
Conversation
Hi @tuxtof thanks for opening up this PR to add Nutanix as an external Packer plugin. I am running into issues rendering to documentation as an external plugin. I'm looking into what might be happening on my end. That said, I'm curious to know if you can visit the nutanix plugin docs locally via the instructions you called on in the PR description. Looking at the released docs.zip I see that there is an overview.mdx and a plugin.mdx file. I would expect this to fail, as the documentation injection script looks for an index.mdx (this becomes the overview) and a nutanix.mdx (which renders as /builders/nutanix). Could you please confirm that you are able to see the Nutanix documentation locally and that it renders correctly; I would except the local URL to be http://localhost:3000/packer/plugins/builders/nutanix https://github.com/nutanix-cloud-native/packer-plugin-nutanix/tree/main/docs/builders |
@tuxtof I stand corrected the documentation renders with the given filenames but it does render differently and errors if you try https://packer-git-feat-add-nutanix-docs-hashicorp.vercel.app/packer/plugins/builders/nutanix and not https://packer-git-feat-add-nutanix-docs-hashicorp.vercel.app/packer/plugins/builders/nutanix/overview. Changing the upstream document names to index.mdx and nutanix.mdx should file this issue. |
Hi @nywilken nice to meet you When i try locally all is perfect i see Nutanix in the TOC and the two link are working http://localhost:3000/plugins/builders/nutanix/overview http://localhost:3000/plugins/builders/nutanix/plugin but on the vercel side i see nothing even if i don't see any error in the workflow let me try to rename file and we will see |
i also tested on https://packer-git-feat-add-nutanix-docs-hashicorp.vercel.app/packer/plugins/ and all seems ok no ?? TOC is here and TOC link is ok !! |
ok @nywilken i have changed the file name |
44483ff
to
6677cef
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@tuxtof thanks for updating the released zip file. The documentation looks good https://packer-htu6hlz2e-hashicorp.vercel.app/packer/plugins/builders/nutanix.
There was an issue our end that was preventing the external plugins docs from being rendered on the website preview script. The fix has been deployed and all should be working as expected.
I'm going to merge this change to get the Nutanix documentation published. But please make sure to rename the documentation files in the source repo as well for future releases.
Thanks @nywilken PR for the name change nutanix-cloud-native/packer-plugin-nutanix#75 |
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. |
Update website/data/plugins-manifest.json to include docs for Nutanix builder plugin
docs.zip was tested by following this procedure to manually build and launch the website.
Website is OK