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

Investigate / resolve link errors #341

Open
mjang opened this issue Apr 1, 2025 · 4 comments
Open

Investigate / resolve link errors #341

mjang opened this issue Apr 1, 2025 · 4 comments
Assignees
Labels
good first issue Good for newcomers product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)

Comments

@mjang
Copy link
Contributor

mjang commented Apr 1, 2025

Describe the bug

CI/CD job https://github.com/nginx/documentation/actions/runs/14190446169/job/39753719002 shows link errors:

404 Not Found: 22 instances
301 Moved Permanently: 13 instances

Collected in the following file:

1_nginx-plus.txt

To reproduce

Rerun CI/CD job

Expected behavior

Minimum: no 404s
Ideal: no 301s either

Note

Possible "Good first issue" if I can figure out a way to "explain" the process

  • Dependency on internal work -- issue # 328 on our docs-platform
  • With that work, we'll have "Edit this page" links on each of our production pages
  • We can then point users to such pages
@mjang mjang added bug Something isn't working product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com) good first issue Good for newcomers and removed bug Something isn't working labels Apr 1, 2025
@FaithKovi
Copy link

Hello @mjang
I would like to work on this issue.

@mjang
Copy link
Contributor Author

mjang commented Apr 3, 2025

Hello @mjang I would like to work on this issue.

Great! I've assigned the issue to you. I look forward to your contributions!

@FaithKovi
Copy link

Hello @mjang , I was able to look at the workflow file for the link checker and also the corresponding links throwing the errors.
Since Nginx is now part of F5, all previous Nginx links have moved to F5.com. Also, within F5, some links have been moved from the initial ones that were used.

Proposed solution: Replacing the link on the workflow file with the correct one would help resolve this.
Let me know what you think.

@mjang
Copy link
Contributor Author

mjang commented Apr 8, 2025

@FaithKovi That would be great!

When I've researched these types of issues, I've:

  • Searched for the original link through the Wayback Machine
  • Found an equivalent with the same content, either at docs.nginx.com or f5.com

Example, here's an excerpt from the linked 1_nginx_plus.txt file:

2025-04-01T08:07:26.2637404Z URL        `https://www.nginx.com/solutions/load-balancing/'
2025-04-01T08:07:26.2638096Z Name       `Load balancing'
2025-04-01T08:07:26.2638677Z Parent URL https://docs.nginx.com/nginx/admin-guide/load-balancer/tcp-udp-load-balancer/, line 3465, col 9   
2025-04-01T08:07:26.2639370Z Real URL   https://www.f5.com/solutions/load-balancing
2025-04-01T08:07:26.2640011Z Check time 2.218 seconds
2025-04-01T08:07:26.2640483Z Size       1KB
2025-04-01T08:07:26.2640868Z Warning    [http-redirected] Redirected to
2025-04-01T08:07:26.2641269Z            `https://www.f5.com/solutions/load-balancing/' status:
2025-04-01T08:07:26.2641683Z            301 Moved Permanently.
2025-04-01T08:07:26.2641998Z            [http-redirected] Redirected to
2025-04-01T08:07:26.2642409Z            `https://www.f5.com/solutions/load-balancing' status:
2025-04-01T08:07:26.2642798Z            301 Moved Permanently.
2025-04-01T08:07:26.2643091Z Result     Error: 404 Not Found

The broken link is at the following URL: https://www.nginx.com/solutions/load-balancing/
The Name of the link is Load balancing
You can find the link at the Parent URL, https://docs.nginx.com/nginx/admin-guide/load-balancer/tcp-udp-load-balancer/

Image

Based on the context, I know I'm looking for a link to docs.nginx.com or f5.com that describes load balancers. With some "googling," I find https://www.f5.com/glossary/load-balancer

Solution: propose a PR to replace the link in https://docs.nginx.com/nginx/admin-guide/load-balancer/tcp-udp-load-balancer/ with https://www.f5.com/glossary/load-balancer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)
Projects
None yet
Development

No branches or pull requests

2 participants