Changes between Initial Version and Version 2 of Ticket #32720


Ignore:
Timestamp:
May 7, 2021, 3:25:20 AM (3 years ago)
Author:
Nick Pope
Comment:

Replying to Mariusz Felisiak:

Thanks, I think adding the linkcheck_ignore configuration makes sense. I would leave a new GitHub action outside of this ticket, otherwise we would have to mark it as "someday/maybe".

Thanks Mariusz. I created #32723 for implementing a GitHub action in the future.

The linkcheck_ignore now will at least help reduce the output that needs to be sifted through when running this manually in the interim.

Legend:

Unmodified
Added
Removed
Modified

  • Ticket #32720

    • Property Triage Stage Unreviewed → Accepted

  • Ticket #32720 – Description

    initial v2  
    1212
    13131. Add some initial configuration and documentation, fix broken links, and "canonicalize" some links to avoid redirects.
    14 1. Add a scheduled GitHub action to check for broken links, or redirects that could be simplified, on a weekly/monthly basis.
     141. ~~Add a scheduled GitHub action to check for broken links, or redirects that could be simplified, on a weekly/monthly basis.~~
    1515
    16 The second step 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/`.
     16~~The second step 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/`.~~
    1717
    18 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.
     18~~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.~~
    1919
    20 Here's a [https://github.com/django/django/pull/14325 PR] for the first step.
     20Here's a [https://github.com/django/django/pull/14325 PR]~~ for the first step~~.
     21
     22(Migrated suggestion for a scheduled GitHub action to #32723.)
Back to Top