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 code reference links in docs #10696

Merged
merged 1 commit into from
Feb 4, 2021

Conversation

bharath-123
Copy link
Contributor

@bharath-123 bharath-123 commented Jan 30, 2021

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.

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

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 30, 2021
@olemarkus
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 30, 2021
@hakman
Copy link
Member

hakman commented Jan 31, 2021

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).
What do you think?

@bharath-123
Copy link
Contributor Author

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.

@olemarkus
Copy link
Member

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.

@bharath-123
Copy link
Contributor Author

Thats a good idea @olemarkus! Thanks! Will fix up the links to point to the pkg.go.dev references!

@bharath-123 bharath-123 force-pushed the task/fix-links branch 2 times, most recently from be1f5bb to cd9d37b Compare February 1, 2021 20:05
@olemarkus
Copy link
Member

/lgtm
/approve

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

[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 /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 Feb 4, 2021
@k8s-ci-robot k8s-ci-robot merged commit 6fa8707 into kubernetes:master Feb 4, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.20 milestone Feb 4, 2021
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. area/documentation 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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants