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

[doc] fix website broken links #1857

Merged

Conversation

alexandear
Copy link
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Fixes broken URLs on https://kueue.sigs.k8s.io/

Which issue(s) this PR fixes:

Special notes for your reviewer:

Broken links found by the linkchecker.

linkchecker output
❯ linkchecker --no-warnings https://kueue.sigs.k8s.io/
INFO linkcheck.cmdline 2024-03-15 22:18:12,314 MainThread Checking intern URLs only; use --check-extern to check extern URLs.
LinkChecker 10.4.0
Copyright (C) 2000-2016 Bastian Kleineidam, 2010-2023 LinkChecker Authors
LinkChecker comes with ABSOLUTELY NO WARRANTY!
This is free software, and you are welcome to redistribute it under
certain conditions. Look at the file `COPYING' within this distribution.
Read the documentation at https://linkchecker.github.io/linkchecker/
Write comments and bugs to https://github.com/linkchecker/linkchecker/issues

Start checking at 2024-03-15 22:18:12+003
10 threads active,    10 links queued,   12 links in  32 URLs checked, runtime 1 seconds
10 threads active,     1 link queued,   41 links in  52 URLs checked, runtime 6 seconds
10 threads active,    34 links queued,   82 links in 126 URLs checked, runtime 11 seconds
10 threads active,    55 links queued,  175 links in 240 URLs checked, runtime 16 seconds
10 threads active,    63 links queued,  276 links in 349 URLs checked, runtime 21 seconds
10 threads active,    62 links queued,  399 links in 471 URLs checked, runtime 26 seconds
10 threads active,    50 links queued,  424 links in 484 URLs checked, runtime 31 seconds

URL        `/docs/reference/kueue.v1.beta1#kueue-x-k8s-io-v1beta1-WorkloadSpec'
Name       `Active'
Parent URL https://kueue.sigs.k8s.io/docs/concepts/workload/, line 324, col 61
Real URL   https://kueue.sigs.k8s.io/docs/reference/kueue.v1.beta1#kueue-x-k8s-io-v1beta1-WorkloadSpec
Check time 3.648 seconds
Result     Error: 404 Not Found

URL        `/docs/tasks/setup_multikue'
Name       `setup a MultiKueue environment'
Parent URL https://kueue.sigs.k8s.io/docs/tasks/, line 287, col 52
Real URL   https://kueue.sigs.k8s.io/docs/tasks/setup_multikue
Check time 3.583 seconds
Result     Error: 404 Not Found
10 threads active,    37 links queued,  437 links in 484 URLs checked, runtime 36 seconds

URL        `docs/concepts/workload/#active'
Name       `deactivates the Workload'
Parent URL https://kueue.sigs.k8s.io/docs/tasks/setup_sequential_admission/, line 357, col 55
Real URL   https://kueue.sigs.k8s.io/docs/tasks/setup_sequential_admission/docs/concepts/workload/#active
Check time 3.746 seconds
Result     Error: 404 Not Found
10 threads active,    22 links queued,  452 links in 484 URLs checked, runtime 41 seconds
10 threads active,     6 links queued,  468 links in 484 URLs checked, runtime 46 seconds

URL        `/docs/tasks/run_mpi_jobs/'
Name       `Run an MPIJob'
Parent URL https://kueue.sigs.k8s.io/docs/tasks/run_python_jobs/, line 1029, col 85
Real URL   https://kueue.sigs.k8s.io/docs/tasks/run_mpi_jobs/
Check time 4.050 seconds
Result     Error: 404 Not Found
 5 threads active,     0 links queued,  479 links in 484 URLs checked, runtime 51 seconds

URL        `docs/concepts/#quota-reservation'
Name       `Quota Reservation'
Parent URL https://kueue.sigs.k8s.io/docs/admission-check-controllers/provisioning/, line 280, col 495
Real URL   https://kueue.sigs.k8s.io/docs/admission-check-controllers/provisioning/docs/concepts/#quota-reservation
Check time 3.945 seconds
Result     Error: 404 Not Found

URL        `code-of-conduct.md'
Name       `code of conduct'
Parent URL https://kueue.sigs.k8s.io/docs/contribution-guidelines/, line 269, col 176
Real URL   https://kueue.sigs.k8s.io/docs/contribution-guidelines/code-of-conduct.md
Check time 3.874 seconds
Result     Error: 404 Not Found

Statistics:
Downloaded: 6.96MB.
Content types: 15 image, 93 text, 0 video, 0 audio, 30 application, 0 mail and 346 other.
URL lengths: min=15, max=1077, avg=169.

That's it. 484 links in 484 URLs checked. 0 warnings found (34 ignored or duplicates not printed). 6 errors found.
Stopped checking at 2024-03-15 22:19:05+003 (53 seconds)

It would be great if we could somehow implement URL checking into the CI pipeline to prevent broken links.

Does this PR introduce a user-facing change?

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 15, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @alexandear. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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 Mar 15, 2024
Copy link

netlify bot commented Mar 15, 2024

Deploy Preview for kubernetes-sigs-kueue ready!

Name Link
🔨 Latest commit c55a3c4
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/65f4b06fab2b1800089535ab
😎 Deploy Preview https://deploy-preview-1857--kubernetes-sigs-kueue.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@alexandear alexandear changed the title [docs] fix website broken links [doc] fix website broken links Mar 15, 2024
@alculquicondor
Copy link
Contributor

/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 Mar 15, 2024
Copy link
Contributor

@alculquicondor alculquicondor left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve
/cherry-pick website

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

LGTM label has been added.

Git tree hash: 198acc315000786b3e0e8661649cb5d2ade51d6d

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alculquicondor, alexandear

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 Mar 15, 2024
@k8s-ci-robot k8s-ci-robot merged commit d99b43b into kubernetes-sigs:main Mar 15, 2024
6 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v0.7 milestone Mar 15, 2024
@alexandear alexandear deleted the docs-fix-site-broken-links branch March 15, 2024 20:47
@tenzen-y
Copy link
Member

/cherry-pick website

@k8s-infra-cherrypick-robot

@tenzen-y: new pull request created: #1859

In response to this:

/cherry-pick website

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.

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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. 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. release-note-none Denotes a PR that doesn't merit a release note. 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

5 participants