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.

Sign up for GitHub

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

Jump to bottom

Fix broken links #7185

Merged
merged 2 commits into from Mar 22, 2024
Merged

Fix broken links #7185

merged 2 commits into from Mar 22, 2024

Conversation

nouralmulhem
Copy link
Contributor

@nouralmulhem nouralmulhem commented Mar 21, 2024 •
edited

this PR handles issue#3335
the broken links were provided in PR#7173
thanks for @zbynek

I'll leave you with some comments on the broken links

Getting links from: http://localhost:8088/blog/2023/09/24/building-jenkinsio-with-alternative-tools/
├─BROKEN─ http://localhost:8088/blog/authors/MarkEWaite (HTTP_404)

False Positive

Getting links from: http://localhost:8088/blog/2023/07/10/jenkins-june-newsletter/
├─BROKEN─ http://localhost:8088/blog/2023/07/10/jenkins-june-newsletter/blog/2020/11/04/codeql/ (HTTP_404)
├─BROKEN─ http://localhost:8088/blog/2023/07/10/jenkins-june-newsletter/blog/2023/06/20/jenkins-may-newsletter/ (HTTP_404)
├─BROKEN─ http://localhost:8088/blog/2023/07/10/jenkins-june-newsletter/blog/2023/06/22/mirrors-jenkins-new-IP/ (HTTP_404)
├─BROKEN─ http://localhost:8088/blog/2023/07/10/jenkins-june-newsletter/blog/2023/06/20/remove-outdated-plugins-while-using-docker/ (HTTP_404)
├─BROKEN─ http://localhost:8088/blog/2023/07/10/jenkins-june-newsletter/doc/book/installing/linux/ (HTTP_404)

DONE

Getting links from: http://localhost:8088/blog/2023/05/10/jenkins-april-newsletter/
├─BROKEN─ http://localhost:8088/blog/authors/MarkEWaite (HTTP_404)
├─BROKEN─ http://localhost:8088/blog/authors/NotMyFault (HTTP_404)

Couldn't reproduce those (work as expected) could be considered False Positive

Getting links from: http://localhost:8088/doc/book/using/pluggable-storage/
├─BROKEN─ http://localhost:8088/doc/developer/extensions/credentials/#credentialsprovider (HTTP_404)
├─BROKEN─ http://localhost:8088/doc/developer/extensions/credentials/#credentialsprovider (HTTP_404)
├─BROKEN─ http://localhost:8088/doc/developer/extensions/credentials/#credentialsprovider (HTTP_404)

the doc/developer/extensions/credentials is not exist - not sure to what this should redirect

Getting links from: http://localhost:8088/security/advisory/2017-02-01/
├─BROKEN─ http://localhost:8088/security-144 (HTTP_404)

False Positive (redirection handled)

Getting links from: http://localhost:8088/projects/gsoc/2020
├─BROKEN─ http://localhost:8088/blog/authors/XiongKezhi (HTTP_404)

False Positive

Getting links from: http://localhost:8088/blog/2023/09/20/renovate-bot-probe-blog/
├─BROKEN─ http://localhost:8088/blog/2023/09/07/16/2023-07-16-security-scan-probe-blog.adoc (HTTP_404)

DONE

Getting links from: http://localhost:8088/blog/2023/08/24/gitlab-plugin-modernization-report/
├─BROKEN─ http://localhost:8088/blog/authors/MarkEWaite/ (HTTP_404)

Couldn't reproduce those (work as expected) could be considered False Positive

Getting links from: http://localhost:8088/blog/2023/07/22/gsoc-2023-midterm/
├─BROKEN─ http://localhost:8088/blog/2023/07/22/gsoc-2023-midterm/blog/2023/07/16/unreleased-production-changes-probe.adoc (HTTP_404)
├─BROKEN─ http://localhost:8088/blog/2023/07/22/gsoc-2023-midterm/blog/2023/07/20/third-party-repository-detection-probe.adoc (HTTP_404)
├─BROKEN─ http://localhost:8088/blog/2023/07/22/gsoc-2023-midterm/blog/2023/07/16/security-scan-probe-blog.adoc (HTTP_404)

DONE

Getting links from: http://localhost:8088/doc/developer/publishing/requesting-hosting/
├─BROKEN─ http://localhost:8088/doc/project/teams/hosting.adoc (HTTP_404)

DONE

Getting links from: http://localhost:8088/blog/2019/10/21/plugin-docs-on-github/
├─BROKEN─ http://localhost:8088/participate/%3Cmark%3Edocument (HTTP_404)

DONE

Getting links from: http://localhost:8088/blog/2020/12/22/gsoc-report/
├─BROKEN─ http://localhost:8088/blog/authors/XiongKezhi (HTTP_404)

False Positive

Getting links from: http://localhost:8088/blog/2020/10/28/election-candidates/
├─BROKEN─ http://localhost:8088/blog/2020/10/28/election-candidates/projects/gsoc/2019/remoting-over-apache-kafka-docker-k8s-features/ (HTTP_404)

DONE

Getting links from: http://localhost:8088/blog/2022/12/27/run-jenkins-agent-as-a-service/
├─BROKEN─ http://localhost:8088/images/post-images/2022-12-02-run-jenkins-agent-as-a-service/curl-and-java-launch-agent.svg (HTTP_404)

this is an svg element, no error in the link the error in the svg itself, can have another svg if that works (design one)

Getting links from: http://localhost:8088/blog/authors/alyssat/page/4.html
├─BROKEN─ http://localhost:8088/images/post-images/jenkins-is-the-way/ebook/ebook3_opengraph.png (HTTP_404)

we don't have the opengraph image for ebook3 (can generate one similar to ebook2)

if this is approved i can update the PR

what we have for ebook2

ebook2_opengraph

what I got for ebook3 (haven't upload this yet)

ebook3_opengraph

Getting links from: http://localhost:8088/security/advisory/2015-11-11/
├─BROKEN─ http://localhost:8088/security-144 (HTTP_404)

Repeated: False Positive (redirection handled)

Getting links from: http://localhost:8088/blog/2018/12/25/year-in-review/
├─BROKEN─ http://localhost:8088/zh/ (HTTP_404)

False Positive

Getting links from: http://localhost:8088/doc/developer/publishing/releasing-cd/
├─BROKEN─ http://localhost:8088/jep/229 (HTTP_404)

DONE (proposed solution: redirecting to https://github.com/jenkinsci/jep/blob/master/jep/229/README.adoc)

Getting links from: http://localhost:8088/blog/tags/remoting/
├─BROKEN─ http://localhost:8088/images/post-images/2021-07-31-remoting-monitoring-phase-1/remoting-monitoring-phase-1-opengraph.png (HTTP_404)

DONE (proposed solution: using opengraph.png instead)

Getting links from: http://localhost:8088/projects/gsoc/2024/project-ideas/cloudevents-plugin/
├─BROKEN─ http://localhost:8088/projects/gsoc/2024/2021/projects/cloudevents-plugin.adoc (HTTP_404)

Couldn't reproduce this

Getting links from: http://localhost:8088/blog/tags/gsoc/page/5.html
├─BROKEN─ http://localhost:8088/images/post-images/2021-07-31-remoting-monitoring-phase-1/remoting-monitoring-phase-1-opengraph.png (HTTP_404)

Repeated: DONE (proposed solution: using opengraph.png instead)

Getting links from: http://localhost:8088/events/fosdem/archive/2020
├─BROKEN─ http://localhost:8088/blog/authors/MarkEWaite/ (HTTP_404)

Couldn't reproduce those (work as expected) could be considered False Positive

Getting links from: http://localhost:8088/blog/2018/09/18/automatically-upgrading-with-evergreen/
├─BROKEN─ http://localhost:8088/images/evergreen/magician_256.png (HTTP_404)

DONE (proposed solution: using images/logos/magician/256.png)

Getting links from: http://localhost:8088/blog/tags/announcement/page/2.html
├─BROKEN─ http://localhost:8088/images/post-images/jenkins-is-the-way/ebook/ebook3_opengraph.png (HTTP_404)

Repeated: we don't have the opengraph image for ebook3 (can generate one similar to ebook2 -proposed design above-)

Getting links from: http://localhost:8088/blog/authors/aki-7/
├─BROKEN─ http://localhost:8088/images/post-images/2021-07-31-remoting-monitoring-phase-1/remoting-monitoring-phase-1-opengraph.png (HTTP_404)

Repeated: DONE (proposed solution: using opengraph.png instead)

Getting links from: http://localhost:8088/blog/tags/jenkins-is-the-way/
├─BROKEN─ http://localhost:8088/images/post-images/jenkins-is-the-way/ebook/ebook3_opengraph.png (HTTP_404)

Repeated: we don't have the opengraph image for ebook3 (can generate one similar to ebook2 -proposed design above-)

Getting links from: http://localhost:8088/blog/tags/gsoc2021/
├─BROKEN─ http://localhost:8088/images/post-images/2021-07-31-remoting-monitoring-phase-1/remoting-monitoring-phase-1-opengraph.png (HTTP_404)

Repeated: DONE (proposed solution: using opengraph.png instead)

Getting links from: http://localhost:8088/blog/2019/05/09/chinese-localization/
├─BROKEN─ http://localhost:8088/zh/ (HTTP_404)

False Positive

Getting links from: http://localhost:8088/blog/tags/case-study/
├─BROKEN─ http://localhost:8088/images/post-images/jenkins-is-the-way/ebook/ebook3_opengraph.png (HTTP_404)

Repeated: we don't have the opengraph image for ebook3 (can generate one similar to ebook2 -proposed design above-)

Getting links from: http://localhost:8088/blog/tags/ebook/
├─BROKEN─ http://localhost:8088/images/post-images/jenkins-is-the-way/ebook/ebook3_opengraph.png (HTTP_404)

Repeated: we don't have the opengraph image for ebook3 (can generate one similar to ebook2 -proposed design above-)

Getting links from: http://localhost:8088/blog/tags/open-telemetry/
├─BROKEN─ http://localhost:8088/images/post-images/2021-07-31-remoting-monitoring-phase-1/remoting-monitoring-phase-1-opengraph.png (HTTP_404)

Repeated: DONE (proposed solution: using opengraph.png instead)

Getting links from: http://localhost:8088/blog/tags/community/page/8.html
├─BROKEN─ http://localhost:8088/images/post-images/jenkins-is-the-way/ebook/ebook3_opengraph.png (HTTP_404)

Repeated: we don't have the opengraph image for ebook3 (can generate one similar to ebook2 -proposed design above-)

Getting links from: http://localhost:8088/blog/2012/09/28/take-the-jenkins-survey/
├─BROKEN─ http://localhost:8088/survey (HTTP_404)

False Positive (but i would prefer having this as http://s.zoomerang.com/s/JenkinsSurvey instead)

Getting links from: http://localhost:8088/blog/page/16.html
├─BROKEN─ http://localhost:8088/images/post-images/jenkins-is-the-way/ebook/ebook3_opengraph.png (HTTP_404)

Repeated: we don't have the opengraph image for ebook3 (can generate one similar to ebook2 -proposed design above-)

Getting links from: http://localhost:8088/blog/page/17.html
├─BROKEN─ http://localhost:8088/images/post-images/2021-07-31-remoting-monitoring-phase-1/remoting-monitoring-phase-1-opengraph.png (HTTP_404)

Repeated: DONE (proposed solution: using opengraph.png instead)

@nouralmulhem nouralmulhem requested review from a team as code owners March 21, 2024 01:37
@probot-autolabeler probot-autolabeler bot added blogpost documentation Jenkins documentation, including user and developer docs, solution pages, etc. labels Mar 21, 2024
@zbynek
Copy link
Contributor

zbynek commented Mar 21, 2024

Looks good.

─BROKEN─ http://localhost:8088/blog/authors/MarkEWaite/ (HTTP_404)

These are reported as broken because of case sensitivity -- not a problem for production site but may seem broken on localhost, depending on your OS. To make sure they are not reported one could update the author of affected blogposts to match the case in data/authors/, e.g. markewaite should be lowercase.

zbynek
zbynek reviewed Mar 21, 2024
View reviewed changes
content/doc/developer/publishing/releasing-cd.adoc
@@ -2,7 +2,7 @@
title: Setting up automated plugin release
layout: developer
references:
- url: /jep/229
Copy link
Contributor

Choose a reason for hiding this comment

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

This actually works on jenkins.io (not for the preview site or localhost). Though the change is not needed, avoiding redirects saves some time browsing, so 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah i could see it working on the jenkins.io when i was comparing but i also see how we usually use this in other files
image
so i thought this can be an improvement anyway

NotMyFault
NotMyFault approved these changes Mar 21, 2024
View reviewed changes
Copy link
Member

@NotMyFault NotMyFault left a comment

Choose a reason for hiding this comment

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

Thanks!

@nouralmulhem
Copy link
Contributor Author

nouralmulhem commented Mar 21, 2024 •
edited

can i get your thoughts about those as well @NotMyFault @zbynek

Getting links from: http://localhost:8088/doc/book/using/pluggable-storage/
├─BROKEN─ http://localhost:8088/doc/developer/extensions/credentials/#credentialsprovider (HTTP_404)
├─BROKEN─ http://localhost:8088/doc/developer/extensions/credentials/#credentialsprovider (HTTP_404)
├─BROKEN─ http://localhost:8088/doc/developer/extensions/credentials/#credentialsprovider (HTTP_404)

the doc/developer/extensions/credentials is not exist - not sure to what this should redirect

Getting links from: http://localhost:8088/blog/2022/12/27/run-jenkins-agent-as-a-service/
├─BROKEN─ http://localhost:8088/images/post-images/2022-12-02-run-jenkins-agent-as-a-service/curl-and-java-launch-agent.svg (HTTP_404)

this is an svg element, no error in the link the error in the svg itself, can have another svg if that works (design one)

Getting links from: http://localhost:8088/blog/authors/alyssat/page/4.html
├─BROKEN─ http://localhost:8088/images/post-images/jenkins-is-the-way/ebook/ebook3_opengraph.png (HTTP_404)

we don't have the opengraph image for ebook3 (can generate one similar to ebook2)

if this is approved i can update the PR

what we have for ebook2

ebook2_opengraph

what I got for ebook3 (haven't upload this yet)

ebook3_opengraph

@nouralmulhem
Copy link
Contributor Author

Looks good.

─BROKEN─ http://localhost:8088/blog/authors/MarkEWaite/ (HTTP_404)

These are reported as broken because of case sensitivity -- not a problem for production site but may seem broken on localhost, depending on your OS. To make sure they are not reported one could update the author of affected blogposts to match the case in data/authors/, e.g. markewaite should be lowercase.

those were working as expected, i use windows may others have them broken, would you prefer if we match the case?

@zbynek
Copy link
Contributor

zbynek commented Mar 21, 2024

would you prefer if we match the case?

No strong preference, fine to merge this as is 👍

doc/developer/extensions/credentials is not exist

When jenkins-infra/helpdesk#3746 is fixed, that page should reappear, no action needed here.

error in the svg itself

Correct SVG is https://www.jenkins.io/images/post-images/2022-12-27-run-jenkins-agent-as-a-service/curl-and-java-launch-agent.svg, the date in URL was not updated when blog post was postponed

can generate one similar to ebook2

sounds good.

@nouralmulhem
Copy link
Contributor Author

@zbynek i think it is ready to go, let me have your thoughts

krisstern
krisstern approved these changes Mar 22, 2024
View reviewed changes
Copy link
Member

@krisstern krisstern left a comment

Choose a reason for hiding this comment

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

LGTM

@MarkEWaite MarkEWaite merged commit 56e3e2b into jenkins-infra:master Mar 22, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zbynek zbynek zbynek approved these changes

@NotMyFault NotMyFault NotMyFault approved these changes

@krisstern krisstern krisstern approved these changes

Assignees
No one assigned
Labels
blogpost documentation Jenkins documentation, including user and developer docs, solution pages, etc.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@nouralmulhem @zbynek @NotMyFault @krisstern @MarkEWaite