[Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.
Django
-------------------------------------+-------------------------------------
Reporter: Nick Pope | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: | Version: dev
Documentation | Keywords: linkcheck, github,
Severity: Normal | action
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
-------------------------------------+-------------------------------------
This is a follow on step from #32720. (Migrated to this new ticket as
[https://code.djangoproject.com/ticket/32720#comment:1 suggested] by
Mariusz.)
Add a scheduled GitHub action to check for broken links, or redirects that
could be simplified, on a weekly/monthly basis.
This would need to wait for [https://github.com/sphinx-
doc/sphinx/issues/6525 sphinx-doc/sphinx#6525] to be addressed so that we
can treat desired redirections as "working" links instead of "redirected",
e.g. `https://docs.djangoproject.com/en/stable/` →
`https://docs.djangoproject.com/en/3.2/`.
The linkcheck builder generates `docs/_build/linkcheck/output.{json,txt}`
which could be filtered and attached as an artifact from the GitHub action
to make it easier to provide a report on what needs fixing.
--
Ticket URL: <https://code.djangoproject.com/ticket/32723>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
-------------------------------------+-------------------------------------
Reporter: Nick Pope | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Severity: Normal | Resolution:
Keywords: linkcheck, github, | Triage Stage:
action | Someday/Maybe
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* stage: Unreviewed => Someday/Maybe
--
Ticket URL: <https://code.djangoproject.com/ticket/32723#comment:1>
Django
-------------------------------------+-------------------------------------
Type: | Abderemane
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: linkcheck, github, | Triage Stage:
action | Someday/Maybe
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* owner: nobody => Sarah Abderemane
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/32723#comment:2>
Django
-------------------------------------+-------------------------------------
Type: | Abderemane
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: linkcheck, github, | Triage Stage:
action | Someday/Maybe
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Sarah Abderemane):
[https://github.com/sphinx-doc/sphinx/issues/6525 sphinx-doc/sphinx#6525]
has been closed and merged in the last release of sphinx. Does the triage
stage will be updated to ''accepted'' according to this ?
--
Ticket URL: <https://code.djangoproject.com/ticket/32723#comment:3>
Django
-------------------------------------+-------------------------------------
Type: | Abderemane
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: linkcheck, github, | Triage Stage:
action | Someday/Maybe
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Nick Pope):
Replying to [comment:3 Sarah Abderemane]:
> [https://github.com/sphinx-doc/sphinx/issues/6525 sphinx-
doc/sphinx#6525] has been closed and merged in the last release of sphinx.
Does the triage stage will be updated to ''accepted'' according to this ?
I'll need to have a look as the entire proposal wasn't implemented with
some work being left for a follow-up.
We'll also need to wait for any changes to be released.
--
Ticket URL: <https://code.djangoproject.com/ticket/32723#comment:4>