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
Documentation: fix the broken links/dead links #26880
Conversation
489fb43
to
32827b7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great overall, thanks!
Please find some links to maybe adjust, and a few questions, inline below.
@@ -903,7 +903,7 @@ test against and allows central control over what data (and at what rate) | |||
is pulled from the api-server and how it’s stored (in-memory or persisted). | |||
|
|||
The resources are usually made available centrally for the application, | |||
e.g. in cilium-agent they’re provided from `pkg/k8s/shared_resources.go <https://github.com/cilium/cilium/blob/main/pkg/k8s/shared_resources.go>`_. | |||
e.g. in cilium-agent they’re provided from `pkg/k8s/resource.go <https://github.com/cilium/cilium/blob/main/pkg/k8s/resource/resource.go>`_. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure about this one, @pippolo84 could you please confirm this is the right link to use?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The correct link is this one: https://github.com/cilium/cilium/blob/main/daemon/k8s/resources.go
Documentation/conf.py
Outdated
'https://jenkins.cilium.io/view/' | ||
] | ||
|
||
linkcheck_anchors = False |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this skip checking the anchors? If so, why should we skip them, are they too hard to check?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As mentioned above I tried to make work on the anchors and changed the one that were
broken, but the md#anchor
even though they exist are throwing the warnings. (not sure why ?)
/src/Documentation/gettingstarted/gettinghelp.rst:47: WARNING: broken link: https://github.com/cilium/cilium.io/blob/main/CONTRIBUTING.md#listing-cilium-training (Anchor 'listing-cilium-training' not found)
/src/Documentation/contributing/testing/e2e_legacy.rst:829: WARNING: broken link: https://github.com/cilium/cilium/blob/26dec4c4f4311df2b1a6c909b27ff7fe6e46929f/test/helpers/kubectl.go#L66-L67 (Anchor 'L66-L67' not found)
/src/Documentation/contributing/testing/e2e_legacy.rst:824: WARNING: broken link: https://github.com/cilium/cilium/blob/26dec4c4f4311df2b1a6c909b27ff7fe6e46929f/test/helpers/kubectl.go#L80-L102 (Anchor 'L80-L102' not found)
/src/Documentation/contributing/testing/e2e_legacy.rst:833: WARNING: broken link: https://github.com/cilium/cilium/blob/26dec4c4f4311df2b1a6c909b27ff7fe6e46929f/test/helpers/kubectl.go#L138-L147 (Anchor 'L138-L147' not found)
/src/Documentation/contributing/testing/ci.rst:40: WARNING: broken link: https://github.com/cilium/community/blob/main/CONTRIBUTOR-LADDER.md#organization-member (Anchor 'organization-member' not found)
/src/Documentation/observability/visibility.rst:78: WARNING: broken link: https://github.com/cilium/cilium/tree/master/api/v1/flow#flow-Layer7 (Anchor 'flow-Layer7' not found)
/src/Documentation/contributing/testing/bpf.rst:52: WARNING: broken link: https://github.com/cilium/ebpf/blob/49ebb13083886fc350167f2cde067e094a2b5037/elf_reader.go#L1074 (Anchor 'L1074' not found)
/src/Documentation/contributing/release/backports.rst:314: WARNING: broken link: https://github.com/cilium/release/blob/3c5fc2bdc38f8d290349a612a03cc83655f57a51/pkg/github/labels.go#L26 (Anchor 'L26' not found)
/src/Documentation/security/network/proxy/envoy.rst:17: WARNING: broken link: https://github.com/cilium/proxy#version-compatibility-matrix (Anchor 'version-compatibility-matrix' not found)
/src/Documentation/community/governance/commit_access.rst:210: WARNING: broken link: https://github.com/cncf/foundation/blob/main/README.md#other-content (Anchor 'other-content' not found)
/src/Documentation/network/servicemesh/grpc.rst:61: WARNING: broken link: https://github.com/fullstorydev/grpcurl#binaries (Anchor 'binaries' not found)
/src/Documentation/helm-reference.rst:740: WARNING: broken link: https://github.com/grafana/helm-charts/tree/main/charts/grafana#sidecar-for-dashboards (Anchor 'sidecar-for-dashboards' not found)
/src/Documentation/network/kubernetes/kata.rst:95: WARNING: broken link: https://github.com/kata-containers/packaging/tree/master/kata-deploy#run-a-sample-workload (Anchor 'run-a-sample-workload' not found)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know :/. I'm travelling today but can take a look into it next week. Please ping me if I forget.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK I had a look, I can reproduce but I don't understand either why these anchors are detected as broken. Maybe the link checker doesn't get exactly what we have in a browser.
So OK let's skip anchors for now, checking the rest of the links would already be a nice improvement.
32827b7
to
e3c73fa
Compare
Commit e3c73fa798896190704365eb4db0059dd72de51e does not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
e3c73fa
to
bc1dce8
Compare
Looks good, thanks! Could you please:
|
Commit 10e04229a9e7d2d65b821345b9a8befb21611ea3 does not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
1 similar comment
Commit 10e04229a9e7d2d65b821345b9a8befb21611ea3 does not contain "Signed-off-by". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
10e0422
to
93b7140
Compare
Signed-off-by: Vipul Singh <singhvipul@microsof.com>
d44a439
to
591fc45
Compare
@vipul-21: You don't have to rebase the branch every time it gets out-of-date (you only need to do this if there are merge conflicts). OK, I think this PR is ready. It touches documentation only, all base tests including for docs are green. We don't have a review for Let's get this merged to fix the docs, and to unblock #27116. |
Please ensure your pull request adheres to the following guidelines:
description and a
Fixes: #XXX
line if the commit addresses a particularGitHub issue.
Fixes: <commit-id>
tag, thenplease add the commit author[s] as reviewer[s] to this issue.
This the first PR to fix #10601. It addresses the broken link in the documentation as well as the links which can be ignored by the link checker.
The #10601 (comment) captures the items we need to close the issue.
Related: #10601