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

Add Nutanix plugin docs #12131

Merged

Conversation

tuxtof
Copy link
Contributor

@tuxtof tuxtof commented Nov 25, 2022

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

@tuxtof tuxtof requested a review from a team as a code owner November 25, 2022 13:23
@hashicorp-cla
Copy link

hashicorp-cla commented Nov 25, 2022

CLA assistant check
All committers have signed the CLA.

@nywilken
Copy link
Contributor

nywilken commented Dec 1, 2022

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

@nywilken
Copy link
Contributor

nywilken commented Dec 1, 2022

@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.

@tuxtof
Copy link
Contributor Author

tuxtof commented Dec 2, 2022

Hi @nywilken nice to meet you

When i try locally all is perfect

i see Nutanix in the TOC

image

and the two link are working

http://localhost:3000/plugins/builders/nutanix/overview

image

http://localhost:3000/plugins/builders/nutanix/plugin

image

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

@tuxtof
Copy link
Contributor Author

tuxtof commented Dec 2, 2022

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 !!

@tuxtof
Copy link
Contributor Author

tuxtof commented Dec 2, 2022

ok @nywilken i have changed the file name
can you check on your side if it is ok

Copy link
Contributor

@nywilken nywilken left a 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.

@nywilken nywilken added docs backport/website Backport PR changes to `stable-website` and latest release branch labels Dec 5, 2022
@nywilken nywilken merged commit abb2f79 into hashicorp:main Dec 5, 2022
@tuxtof
Copy link
Contributor Author

tuxtof commented Dec 5, 2022

@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

@tuxtof tuxtof deleted the feat/add-nutanix-docs branch December 5, 2022 18:12
@nywilken nywilken added this to the 1.8.5 milestone Dec 12, 2022
@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 issues.
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 Jan 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport/website Backport PR changes to `stable-website` and latest release branch docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants