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.

Sign up for GitHub

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

Jump to bottom

📖 Add the Admission webhooks link in docs/book/src/reference/admisson-webhook.md #3799

Merged
merged 1 commit into from
Feb 27, 2024
Merged

📖 Add the Admission webhooks link in docs/book/src/reference/admisson-webhook.md #3799

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions docs/book/src/reference/admission-webhook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Admission Webhooks

[Admission webhooks][k8s-doc-admission-webhooks] are HTTP callbacks that receive admission requests, process
[Admission webhooks](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#what-are-admission-webhooks) are HTTP callbacks that receive admission requests, process
them and return admission responses.

Kubernetes provides the following types of admission webhooks:
Expand Down Expand Up @@ -99,5 +99,3 @@ spec:
While certain edge scenarios might allow a mutating webhook to seamlessly modify the status, treading this path isn't a
universally acclaimed or recommended strategy. Entrusting the controller logic with status updates remains the
most advocated approach.

[k8s-doc-admission-webhooks]: https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#what-are-admission-webhooks
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should use an alias as it is now so that it makes it easier us keep things maintained (allows re-usage, easily identify where we need to update etc)

So, can you please share with us what is the motivation for this PR?
is the link wrong?

Copy link
Contributor Author

@renormalize renormalize Feb 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rendered page on the website (with the alias) does not show up as an embedded hyperlink to the Kubernetes docs, and shows up as [Admission webhooks][k8s-doc-admission-webhooks].

20240227_17h28m08s_grim

The link (which is correct) just shows up as plain text at the end of the rendered page.

20240227_17h27m56s_grim

Since the rendered page did not link to the page on hover/click, I took it to be a lost TODO, but now I have come to realize that it is simply an error in the rendering of the page on the website.

Apologies for the unnecessary PR! Should I take a look into why the rendering is failing for the website? The preview of the .md file locally renders correctly, however.

Loading