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

Lots of broken links #80

Open
danielledeleo opened this issue Jan 11, 2024 · 3 comments
Open

Lots of broken links #80

danielledeleo opened this issue Jan 11, 2024 · 3 comments

Comments

@danielledeleo
Copy link
Contributor

danielledeleo commented Jan 11, 2024

Update (Feb 12), after #96

Of the broken links I have identified 15 false positives:

(click to expand)
# localhost examples
howto/jira.rst:116: [http://localhost/jira]
howto/roundcube.rst:63: [http://localhost/installer/]
howto/bugzilla.rst:80: [http://localhost]
howto/mediawiki.rst:127: [http://localhost/mw-config/index.php]

# present on live site (only fails locally)
howto/security.rst:19: [/CHANGES.txt] ()
index.rst:31: [/rss.xml] ()
news/2023/unit-1.31.1-released.rst:71: [../../../CHANGES.txt] ()

# GitHub anchors that require JavaScript (I manually verified these are all present)
howto/responder.rst:36: [https://github.com/kennethreitz/responder/blob/c6f3a7364cfa79805b0d51eea011fe34d9bd331a/responder/api.py#L501] (Anchor 'L501' not found)
news/2022/unit-1.27.0-released.rst:166: [https://github.com/nginx/unit#readme] (Anchor 'readme' not found)
howto/opengrok.rst:22: [https://github.com/oracle/opengrok/wiki/How-to-setup-OpenGrok#step2---deploy-the-web-application] (Anchor 'step2---deploy-the-web-application' not found)
howto/roundcube.rst:71: [https://github.com/roundcube/roundcubemail/wiki/Installation#protect-your-installation] (Anchor 'protect-your-installation' not found)
howto/roundcube.rst:63: [https://github.com/roundcube/roundcubemail/wiki/Installation#configuring-roundcube] (Anchor 'configuring-roundcube' not found)
howto/roundcube.rst:1: [https://github.com/roundcube/roundcubemail/wiki/Installation#install-dependencies] (Anchor 'install-dependencies' not found)
howto/datasette.rst:18: [https://github.com/simonw/datasette/blob/4f7c0ebd85ccd8c1853d7aa0147628f7c1b749cc/datasette/app.py#L169] (Anchor 'L169' not found)

# user agent block
news/2018/unit-1.0-released.rst:9: [https://www.un.org/en/observances/human-spaceflight-day] (403 Client Error: Forbidden for url: https://www.un.org/en/observances/human-spaceflight-day)

And 8 links are still broken:

# missing/renamed anchors
news/2022/unit-cve-no-impact.rst:7: [https://nvd.nist.gov/vuln/detail/CVE-2022-40674#vulnCurrentDescriptionTitle] (Anchor 'vulnCurrentDescriptionTitle' not found)
news/2018/unit-beta-0.6-released.rst:53: [https://unit.nginx.org/installation/#precompiled-packages] (Anchor 'precompiled-packages' not found)
howto/security.rst:731: [https://www.nginx.com/blog/nginx-unit-updates-for-summer-2021-now-available/#Static-Content:-Chrooting-and-Path-Restrictions] (Anchor 'Static-Content:-Chrooting-and-Path-Restrictions' not found)

# redirects to a newer version of the docs
howto/reviewboard.rst:51: [https://www.reviewboard.org/docs/manual/dev/admin/installation/creating-sites/#changing-permissions] (Anchor 'changing-permissions' not found)
howto/reviewboard.rst:1: [https://www.reviewboard.org/docs/manual/dev/admin/installation/linux/#before-you-begin] (Anchor 'before-you-begin' not found)
howto/reviewboard.rst:23: [https://www.reviewboard.org/docs/manual/dev/admin/installation/linux/#installing-review-board] (Anchor 'installing-review-board' not found)

# actual 404, docs appear to have moved
howto/plone.rst:20: [https://docs.plone.org/manage/installing/installation.html] (404 Client Error: Not Found for url: https://6.docs.plone.org/manage/installing/installation.html)
howto/plone.rst:1: [https://docs.plone.org/manage/installing/requirements.html] (404 Client Error: Not Found for url: https://6.docs.plone.org/manage/installing/requirements.html)

Of these, the first three NGINX-related anchors are easy fixes. I will create separate issues to review our Plone and ReviewBoard examples to make sure those how-tos are up-to-date.

Previous link check (Jan 11) Running `make check` I found 37 broken links:
(  howto/security: line   19) broken    /CHANGES.txt -
(           index: line   31) broken    /rss.xml -
(news/2023/unit-1.31.1-released: line   71) broken    ../../../CHANGES.txt -
(  howto/bugzilla: line   80) broken    http://localhost - HTTPConnectionPool(host='localhost', port=80): Max retries exceeded with url: / (Caused by NewConnectionError('<urllib3.connection.HTTPConnection object at 0x1052f6310>: Failed to establish a new connection: [Errno 61] Connection refused'))
(      howto/jira: line  116) broken    http://localhost/jira - HTTPConnectionPool(host='localhost', port=80): Max retries exceeded with url: /jira (Caused by NewConnectionError('<urllib3.connection.HTTPConnection object at 0x1052effd0>: Failed to establish a new connection: [Errno 61] Connection refused'))
( howto/mediawiki: line  127) broken    http://localhost/mw-config/index.php - HTTPConnectionPool(host='localhost', port=80): Max retries exceeded with url: /mw-config/index.php (Caused by NewConnectionError('<urllib3.connection.HTTPConnection object at 0x105d420d0>: Failed to establish a new connection: [Errno 61] Connection refused'))
( howto/roundcube: line   63) broken    http://localhost/installer/ - HTTPConnectionPool(host='localhost', port=80): Max retries exceeded with url: /installer/ (Caused by NewConnectionError('<urllib3.connection.HTTPConnection object at 0x105d78990>: Failed to establish a new connection: [Errno 61] Connection refused'))
(   configuration: line  126) broken    https://datatracker.ietf.org/doc/html/rfc3986#section-2-1 - Anchor 'section-2-1' not found
(   configuration: line 1797) broken    https://datatracker.ietf.org/doc/html/rfc3986#section-3-3 - Anchor 'section-3-3' not found
(   configuration: line  861) broken    https://datatracker.ietf.org/doc/html/rfc3986#section-3-4 - Anchor 'section-3-4' not found
(   configuration: line  924) broken    https://datatracker.ietf.org/doc/html/rfc3986#section-4-2 - Anchor 'section-4-2' not found
(   configuration: line 1415) broken    https://datatracker.ietf.org/doc/html/rfc4291#section-2-3 - Anchor 'section-2-3' not found
(   configuration: line  881) broken    https://datatracker.ietf.org/doc/html/rfc9110#section-6-3 - Anchor 'section-6-3' not found
(   configuration: line  887) broken    https://datatracker.ietf.org/doc/html/rfc9110#section-7-2 - Anchor 'section-7-2' not found
(     howto/plone: line   20) broken    https://docs.plone.org/manage/installing/installation.html - 404 Client Error: Not Found for url: https://6.docs.plone.org/manage/installing/installation.html
(     howto/plone: line    1) broken    https://docs.plone.org/manage/installing/requirements.html - 404 Client Error: Not Found for url: https://6.docs.plone.org/manage/installing/requirements.html
(news/2022/unit-1.27.0-released: line  166) broken    https://github.com/nginx/unit#readme - Anchor 'readme' not found
(  howto/opengrok: line   22) broken    https://github.com/oracle/opengrok/wiki/How-to-setup-OpenGrok#step2---deploy-the-web-application - Anchor 'step2---deploy-the-web-application' not found
( howto/roundcube: line    1) broken    https://github.com/roundcube/roundcubemail/wiki/Installation#install-dependencies - Anchor 'install-dependencies' not found
( howto/roundcube: line   63) broken    https://github.com/roundcube/roundcubemail/wiki/Installation#configuring-roundcube - Anchor 'configuring-roundcube' not found
( howto/roundcube: line   71) broken    https://github.com/roundcube/roundcubemail/wiki/Installation#protect-your-installation - Anchor 'protect-your-installation' not found
( howto/datasette: line   18) broken    https://github.com/simonw/datasette/blob/4f7c0ebd85ccd8c1853d7aa0147628f7c1b749cc/datasette/app.py#L169 - Anchor 'L169' not found
( howto/responder: line   36) broken    https://github.com/taoufik07/responder/blob/103816e27ae928d42ed850190472480124ba90e3/responder/api.py#L360 - Anchor 'L360' not found
(       community: line   25) broken    https://hg.nginx.org/unit/file/tip/LICENSE - 403 Client Error: Forbidden for url: https://hg.nginx.org/unit/file/tip/LICENSE
(   howto/modules: line  114) broken    https://hg.nginx.org/unit/file/tip/pkg/ - 403 Client Error: Forbidden for url: https://hg.nginx.org/unit/file/tip/pkg/
(       community: line   56) broken    https://hg.nginx.org/unit/file/tip/tools - 403 Client Error: Forbidden for url: https://hg.nginx.org/unit/file/tip/tools
(   howto/laravel: line   16) broken    https://laravel.com/docs/installation#installation-via-composer - Anchor 'installation-via-composer' not found
(    installation: line 2294) broken    https://openports.se/www/unit - 404 Client Error: Not Found for url: https://openports.se/www/unit
(news/2022/unit-cve-no-impact: line    7) broken    https://nvd.nist.gov/vuln/detail/CVE-2022-40674#vulnCurrentDescriptionTitle - Anchor 'vulnCurrentDescriptionTitle' not found
( howto/responder: line    3) broken    https://responder.kennethreitz.org/en/latest/#installing-responder - 404 Client Error: Not Found for url: https://responder.kennethreitz.org/en/latest/
( howto/responder: line   18) broken    https://responder.kennethreitz.org/en/latest/quickstart.html#declare-a-web-service - 404 Client Error: Not Found for url: https://responder.kennethreitz.org/en/latest/quickstart.html
( howto/responder: line   11) broken    https://responder.kennethreitz.org/en/latest/# - 404 Client Error: Not Found for url: https://responder.kennethreitz.org/en/latest/
(news/2018/unit-beta-0.6-released: line   53) broken    https://unit.nginx.org/installation/#precompiled-packages - Anchor 'precompiled-packages' not found
(  howto/security: line  731) broken    https://www.nginx.com/blog/nginx-unit-updates-for-summer-2021-now-available/#Static-Content:-Chrooting-and-Path-Restrictions - Anchor 'Static-Content:-Chrooting-and-Path-Restrictions' not found
(howto/reviewboard: line   51) broken    https://www.reviewboard.org/docs/manual/dev/admin/installation/creating-sites/#changing-permissions - Anchor 'changing-permissions' not found
(howto/reviewboard: line    1) broken    https://www.reviewboard.org/docs/manual/dev/admin/installation/linux/#before-you-begin - Anchor 'before-you-begin' not found
(howto/reviewboard: line   23) broken    https://www.reviewboard.org/docs/manual/dev/admin/installation/linux/#installing-review-board - Anchor 'installing-review-board' not found
@danielledeleo
Copy link
Contributor Author

Many of these are missing anchors, but the parent path still resolves. Lots are actually broken though.

@ac000
Copy link
Member

ac000 commented Jan 12, 2024

I don't think we need these anymore... seeing as we're no longer using RB.

(howto/reviewboard: line   51) broken    https://www.reviewboard.org/docs/manual/dev/admin/installation/creating-sites/#changing-permissions - Anchor 'changing-permissions' not found
(howto/reviewboard: line    1) broken    https://www.reviewboard.org/docs/manual/dev/admin/installation/linux/#before-you-begin - Anchor 'before-you-begin' not found
(howto/reviewboard: line   23) broken    https://www.reviewboard.org/docs/manual/dev/admin/installation/linux/#installing-review-board - Anchor 'installing-review-board' not found

@danielledeleo
Copy link
Contributor Author

A good number of these are false positives.

@ac000, these are the docs for hosting RB on Unit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants