-
Notifications
You must be signed in to change notification settings - Fork 1.6k
🐛 Fix multiversion doc webhook wrong apiVersion #4784
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
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Damien Dassieu <dassieu.damien@gmail.com>
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: damsien The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Hi @damsien. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
/hold It seems to broke the tutorial see: https://deploy-preview-4784--kubebuilder.netlify.app/multiversion-tutorial/webhooks And see how it is today: https://book.kubebuilder.io/multiversion-tutorial/webhooks |
@varshaprasad96 could you please give a look on this one and help me out to see if we should change? |
Hello @camilamacedo86 , I am sorry that I didn't answer earlier but I still look into this! The thing is that I feel like I'm getting stuck :/ |
The Kubernetes project currently lacks enough contributors to adequately respond to all PRs. This bot triages PRs according to the following rules:
You can:
Please send feedback to sig-contributor-experience at kubernetes/community. /lifecycle stale |
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.
Hi @damsien, the book uses literatego
to extract code and comments from the source files and render them in the book. This preprocessor relies on formatted comments (both /* ... */
style block comments for the content and // +kubebuilder:docs-gen:collapse=
for collapsible sections) to work correctly.
Could you please take a look at the v1
version of the webhook file and compare it with the v2
file? I think you'll spot the difference in the comments, which is likely the cause of the rendering issue @camilamacedo86 is referring to.
Let me know if you need any help!
Fixes #4614
The wrong webhook version was used for the documentation.
Ran
make generate