-
Notifications
You must be signed in to change notification settings - Fork 4.7k
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 code reference links in docs #10696
Conversation
Hi @bharath-123. Thanks for your PR. I'm waiting for a kubernetes 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/test-infra repository. |
/ok-to-test |
I don't think it's sustainable to change these line numbers all the time. I thin wither using the current master tag or keeping master and removing line would be better (once you get to the right file, a quick search is not that hard). |
Yeah that was in my mind while raising this PR. I think we should point to the right file and be more explicit in the docs about the struct name and method name so that the reader knows what to search for at least. |
It may be better to replace e.g https://github.com/kubernetes/kops/blob/master/upup/pkg/fi/cloudup/apply_cluster.go#L89 with a link to https://pkg.go.dev/k8s.io/kops/upup/pkg/fi/cloudup#ApplyClusterCmd These docs has up-to-date line references. |
Thats a good idea @olemarkus! Thanks! Will fix up the links to point to the pkg.go.dev references! |
be1f5bb
to
cd9d37b
Compare
cd9d37b
to
e37cb87
Compare
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: bharath-123, olemarkus 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 |
Update out of date code reference links in the how it works doc. These out of date links had me confused a bit while reading the docs.