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

Update links in extensible-admission-controllers.md #26060

Closed
wants to merge 1 commit into from

Conversation

Abirdcfly
Copy link
Member

update link

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

Welcome @Abirdcfly!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. language/en Issues or PRs related to English language labels Jan 12, 2021
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jan 12, 2021
@Abirdcfly
Copy link
Member Author

/assign @kbhawkey

@netlify
Copy link

netlify bot commented Jan 12, 2021

✔️ Deploy preview for kubernetes-io-master-staging ready!

🔨 Explore the source changes: 257794c

🔍 Inspect the deploy logs: https://app.netlify.com/sites/kubernetes-io-master-staging/deploys/5ffeaff90e3e7200088a2e33

😎 Browse the preview: https://deploy-preview-26060--kubernetes-io-master-staging.netlify.app

@kbhawkey
Copy link
Contributor

@kbhawkey
Copy link
Contributor

/retitle Update links in extensible-admission-controllers.md

@k8s-ci-robot k8s-ci-robot changed the title Update extensible-admission-controllers.md Update links in extensible-admission-controllers.md Jan 12, 2021
@kbhawkey
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 12, 2021
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 717bab5bab14a39d5829e756d277ad6375879cd3

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Aut0R3V
To complete the pull request process, please assign kbhawkey after the PR has been reviewed.
You can assign the PR to them by writing /assign @kbhawkey in a comment when ready.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tengqm
Copy link
Contributor

tengqm commented Jan 13, 2021

Pointing to old versions of source code is not ideal. However, pointing to the "master" branch is not a good idea either because the "master" is a moving target.
Please think twice... do we really need this link to the source code? If we do, can we use a more recent tag (rather than branch) as the link target?

@k8s-ci-robot
Copy link
Contributor

New changes are detected. LGTM label has been removed.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 13, 2021
@Abirdcfly
Copy link
Member Author

Pointing to old versions of source code is not ideal. However, pointing to the "master" branch is not a good idea either because the "master" is a moving target.
Please think twice... do we really need this link to the source code? If we do, can we use a more recent tag (rather than branch) as the link target?

It is common to pointing to source code. And If we want to explain clearly, it is necessary to show the source code. I have change master branch to param "githubbranch" like other pages do. 😊

@Abirdcfly
Copy link
Member Author

/assign @kbhawkey

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

I like the idea of this PR. I'm worried though that these changes make things more fragile - see inline feedback.

@@ -67,7 +67,7 @@ See the [webhook request](#request) section for details on the data sent to webh
See the [webhook response](#response) section for the data expected from webhooks.

The example admission webhook server leaves the `ClientAuth` field
[empty](https://github.com/kubernetes/kubernetes/blob/v1.13.0/test/images/webhook/config.go#L47-L48),
[empty](https://github.com/kubernetes/kubernetes/blob/{{< param "githubbranch" >}}/test/images/agnhost/webhook/config.go#L38-L39),
Copy link
Contributor

Choose a reason for hiding this comment

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

If hyperlinking to a specific line, it's better to pin to a named branch (the latest release is a good choice). Otherwise if that file changes the line might end up reading something else.

Copy link
Member Author

Choose a reason for hiding this comment

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

I have check these specific line in version 1.17 to 1.20 it points to same items. 😊 If we change source code, I think it is a good idea to change website too.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi @Abirdcfly .
It would be helpful to get this link updated.
Since the parameter githubbranch resolves to master, would you change this section of the link
to the current version, 1.20.0, or possibly the variable, fullversion?
This link may change in the future?

@Abirdcfly
Copy link
Member Author

ping @kbhawkey

@kbhawkey
Copy link
Contributor

Pointing to old versions of source code is not ideal. However, pointing to the "master" branch is not a good idea either because the "master" is a moving target.
Please think twice... do we really need this link to the source code? If we do, can we use a more recent tag (rather than branch) as the link target?

Hi @Abirdcfly . What do you think about updating the version in the links to the latest version, v1.20.0? Will that work?

@Abirdcfly
Copy link
Member Author

Pointing to old versions of source code is not ideal. However, pointing to the "master" branch is not a good idea either because the "master" is a moving target.
Please think twice... do we really need this link to the source code? If we do, can we use a more recent tag (rather than branch) as the link target?

Hi @Abirdcfly . What do you think about updating the version in the links to the latest version, v1.20.0? Will that work?

It work. There are two choices:
1>. We point to v1.20.0 and when k8s v1.21.0 release, we update link to v1.21.0 ?
2>. We point to master ( param "githubbranch" like other pages ) and when source code changes, we update this link.
Based on the historical update frequency of these source code,, I think 2> is more appropriate.

@tengqm
Copy link
Contributor

tengqm commented Jan 20, 2021

Pointing to master/main is never a good choice to me. Please consider pointing to a tag for latest release.

@tengqm
Copy link
Contributor

tengqm commented Mar 26, 2021

/close

@k8s-ci-robot
Copy link
Contributor

@tengqm: Closed this PR.

In response to this:

/close

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/test-infra repository.

@Abirdcfly Abirdcfly deleted the patch-1 branch September 1, 2021 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants