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

📖 fix marker for webhook server in the tutorial samples and position of explanations #4155

Merged

Conversation

camilamacedo86
Copy link
Member

Apply the fix introduced in PR #4122. The default markers in the code have been replaced with the values defined in the hack/docs, but this change was missed in the tutorial samples.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 10, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 10, 2024
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 10, 2024
@camilamacedo86 camilamacedo86 changed the title 📖 fix marker for webhook server in the tutorial samples WIP 📖 fix marker for webhook server in the tutorial samples Sep 10, 2024
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 10, 2024
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 11, 2024
@camilamacedo86 camilamacedo86 force-pushed the fix-marker-samples-docs branch 2 times, most recently from 6cdf381 to b4840a3 Compare September 11, 2024 07:28
@camilamacedo86 camilamacedo86 changed the title WIP 📖 fix marker for webhook server in the tutorial samples WIP 📖 fix marker for webhook server in the tutorial samples and position of explanations Sep 11, 2024
…ithout overwriting webhook markers

Ensure we are more precise with  operations to avoid overwriting the default scaffolding. Previously, the markers in the scaffold were unintentionally overwritten when injecting code and documentation, which could override crucial changes.

This commit ensures the fix applied in PR kubernetes-sigs#4122 is preserved by refining the tutorial instructions to avoid overwriting webhook markers while still injecting the necessary information.

Either we should not export the consts used in the hack/docs since those are internal implementations, therefore the consts used in this area affected have their name changed
@camilamacedo86 camilamacedo86 changed the title WIP 📖 fix marker for webhook server in the tutorial samples and position of explanations 📖 fix marker for webhook server in the tutorial samples and position of explanations Sep 11, 2024
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 11, 2024
@camilamacedo86
Copy link
Member Author

Small fix for docs, but that blocks further initiatives.

I will not make nobody waste time in reviews.
However, if you would like to change anything here and improve it please feel free and raise a PR with your suggestions
Your help is welcome !!

Moving forward.

@camilamacedo86 camilamacedo86 added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 11, 2024
@camilamacedo86 camilamacedo86 merged commit ec3bf70 into kubernetes-sigs:master Sep 11, 2024
17 of 22 checks passed
@camilamacedo86 camilamacedo86 deleted the fix-marker-samples-docs branch September 11, 2024 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants