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

Documentation: fix the broken links/dead links #26880

Merged
merged 1 commit into from Jul 28, 2023

Conversation

vipul-21
Copy link
Contributor

@vipul-21 vipul-21 commented Jul 17, 2023

Please ensure your pull request adheres to the following guidelines:

  • For first time contributors, read Submitting a pull request
  • All code is covered by unit and/or runtime tests where feasible.
  • All commits contain a well written commit description including a title,
    description and a Fixes: #XXX line if the commit addresses a particular
    GitHub issue.
  • If your commit description contains a Fixes: <commit-id> tag, then
    please add the commit author[s] as reviewer[s] to this issue.
  • All commits are signed off. See the section Developer’s Certificate of Origin
  • Provide a title or release-note blurb suitable for the release notes.
  • Are you a user of Cilium? Please add yourself to the Users doc
  • Thanks for contributing!

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

@vipul-21 vipul-21 requested review from a team as code owners July 17, 2023 23:33
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Jul 17, 2023
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label Jul 17, 2023
Copy link
Member

@qmonnet qmonnet left a 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.

Documentation/network/kubernetes/kubeproxy-free.rst Outdated Show resolved Hide resolved
@@ -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>`_.
Copy link
Member

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?

Copy link
Member

Choose a reason for hiding this comment

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

Documentation/network/kubernetes/compatibility.rst Outdated Show resolved Hide resolved
'https://jenkins.cilium.io/view/'
]

linkcheck_anchors = False
Copy link
Member

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?

Copy link
Contributor Author

@vipul-21 vipul-21 Jul 18, 2023

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)

Copy link
Member

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.

Copy link
Member

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.

@qmonnet qmonnet added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. labels Jul 18, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Jul 18, 2023
@maintainer-s-little-helper
Copy link

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

@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Jul 19, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Jul 19, 2023
@vipul-21 vipul-21 requested a review from qmonnet July 20, 2023 15:30
@qmonnet qmonnet requested a review from pippolo84 July 24, 2023 11:01
@qmonnet
Copy link
Member

qmonnet commented Jul 24, 2023

Looks good, thanks! Could you please:

  • Squash the changes from your second commit into the first one
  • Split into two commits, but differently: I would like all URL fixes in one, and the conf.py additions in a second. Ideally, the changes for conf.py should go along enabling the linkchecker in CI, in a separate PR, but I'm OK to have them here in a separate commit.
  • Rebase on top of the current main branch, this should address the CI issues.

@qmonnet qmonnet removed the request for review from pippolo84 July 24, 2023 13:30
@maintainer-s-little-helper
Copy link

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
@maintainer-s-little-helper
Copy link

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

@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Jul 25, 2023
Signed-off-by: Vipul Singh <singhvipul@microsof.com>
@qmonnet
Copy link
Member

qmonnet commented Jul 28, 2023

@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 sig-k8s but we're not changing the contents of the docs, just fixing the links; and the new links all look good to me.

Let's get this merged to fix the docs, and to unblock #27116.

@qmonnet qmonnet added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Jul 28, 2023
@dylandreimerink dylandreimerink merged commit d140758 into cilium:main Jul 28, 2023
40 checks passed
@sayboras sayboras mentioned this pull request Jul 31, 2023
6 tasks
@sayboras sayboras added backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. and removed needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Jul 31, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from main to Backport pending to v1.14 in 1.14.1 Jul 31, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from main to Backport pending to v1.14 in 1.14.1 Jul 31, 2023
@sayboras sayboras mentioned this pull request Jul 31, 2023
3 tasks
@sayboras sayboras added backport-pending/1.13 The backport for Cilium 1.13.x for this PR is in progress. and removed needs-backport/1.13 This PR / issue needs backporting to the v1.13 branch labels Jul 31, 2023
@sayboras sayboras mentioned this pull request Jul 31, 2023
2 tasks
@sayboras sayboras mentioned this pull request Aug 1, 2023
6 tasks
@sayboras sayboras added backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. and removed backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. labels Aug 3, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.14 to Backport done to v1.14 in 1.14.1 Aug 3, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.14 to Backport done to v1.14 in 1.14.1 Aug 3, 2023
@sayboras sayboras added backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. backport-done/1.12 The backport for Cilium 1.12.x for this PR is done. and removed backport-pending/1.13 The backport for Cilium 1.13.x for this PR is in progress. backport-pending/1.12 labels Aug 3, 2023
@nebril nebril moved this from Needs backport from main to Backport done to v1.13 in 1.13.6 Aug 10, 2023
@asauber asauber moved this from Needs backport from main to Backport done to v1.12 in 1.12.13 Aug 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.12 The backport for Cilium 1.12.x for this PR is done. backport-done/1.13 The backport for Cilium 1.13.x for this PR is done. backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. kind/community-contribution This was a contribution made by a community member. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.12.13
Backport done to v1.12
1.13.6
Backport done to v1.13
1.14.1
Backport done to v1.14
Development

Successfully merging this pull request may close these issues.

CI: Links in docs are not tested
6 participants