Re: [Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
 Reporter:  Nick Pope|Owner:  Sarah
 Type:   |  Abderemane
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  dev
 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
-+-

Comment (by Sarah Abderemane):

 Sorry for the inconvenience Nick, thanks for the quick response. I will
 check if the triage status only changes.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/01070183d14941b4-58e0bcff-f83a-401d-994d-e076b236b780-00%40eu-central-1.amazonses.com.

Re: [Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
 Reporter:  Nick Pope|Owner:  Sarah
 Type:   |  Abderemane
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  dev
 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
-+-

Comment (by Nick Pope):

 My previous comment above still stands - it was posted after that change
 to Sphinx was merged.

 The change made was only part of the solution, so we cannot really
 progress here yet.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/01070183d0421342-8f515663-7a61-4d34-a5e0-d3dec81443bb-00%40eu-central-1.amazonses.com.

Re: [Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
 Reporter:  Nick Pope|Owner:  Sarah
 Type:   |  Abderemane
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  dev
 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
-+-

Comment (by Sarah Abderemane):

 Hi Ralph,  I was waiting this issue to be resolved https://github.com
 /sphinx-doc/sphinx/issues/9234 and the triage stage to be changed.
 Nick or Jacob, or someone else who have the knowledge, do you think it's
 ok to change the triage stage or there are some stuff to be checked before
 to change the status of this ticket ?

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/01070183d02b3a24-bdfd979f-da53-4bba-a643-127f1555d184-00%40eu-central-1.amazonses.com.

Re: [Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
 Reporter:  Nick Pope|Owner:  Sarah
 Type:   |  Abderemane
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  dev
 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
-+-

Comment (by Ralph Reid):

 Hi Sarah, I have some spare cycles to help out. Has the closed reference
 ticket https://github.com/sphinx-doc/sphinx/issues/6525 moved this ticket
 further?
 Thanks.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/01070183cd946dba-6e4d8df4-0061-4654-b98f-a2e0e34e4da5-00%40eu-central-1.amazonses.com.

Re: [Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
 Reporter:  Nick Pope|Owner:  Sarah
 Type:   |  Abderemane
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  dev
 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
-+-

Comment (by Sarah Abderemane):

 Thanks Nick and Jacob for your replies. I understand better what it
 implies to do before this ticket, I'll follow up to see how it will
 involves.
 I agree, the triage stage is confusing, even more for me when I didn't
 know what it implies really. I think it will be good to have many more
 entries for better understanding for everyone.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.0d2aa363944b6a39201236af68e33512%40djangoproject.com.

Re: [Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
 Reporter:  Nick Pope|Owner:  Sarah
 Type:   |  Abderemane
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  dev
 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
-+-

Comment (by Nick Pope):

 Thanks for looking into this Jacob.

 So, yes, I was waiting for the feature to be added to Sphinx, but there
 were some complications over the implementation, so it is only part of
 what would be needed. It's on my very long list of things to look into.
 The main problem is that substituting the captures from the source pattern
 into the target pattern using back-references precludes the use of back-
 references for repeating captured groups within the target pattern.

 At this stage I think we still need to wait until something further is
 implemented in Sphinx. That is why I flagged this "Someday/Maybe". I think
 we'd require a great many more entries because we can't make it generic
 enough. On top of that, one of the reasons for wanting to be able to
 substitute from the source to the target is to ensure that we're actually
 redirected to the right page. This whole thing is intended to make
 linkcheck useful for documentation sites that redirect for language and
 version, but not mask other potential issues.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.db517c16af59fd208eb6f78c12da092e%40djangoproject.com.

Re: [Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
 Reporter:  Nick Pope|Owner:  Sarah
 Type:   |  Abderemane
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  dev
 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
-+-

Comment (by Jacob Walls):

 Hey Sarah. Took a look myself. I believe Nick was hoping for changes in
 Sphinx to allow regexes like these [https://github.com/sphinx-
 doc/sphinx/issues/6525#issuecomment-828730361 like these] with
 backreferences, but testing against the latest version of Sphinx, they
 aren't supported:

 {{{
 WARNING: Failed to compile regex in linkcheck_allowed_redirects:
 '^https://\\1\\.readthedocs\\.io/[-a-z]+/(?:master|latest|stable)/$'
 invalid group reference 1
 WARNING: Failed to compile regex in linkcheck_allowed_redirects:
 '^https://docs\\.djangoproject\\.com/\\1/\\d+\\.\\d+/' invalid group
 reference 1
 }}}

 However the released Sphinx changes ''would'' allow regexes without the
 backreferences. So if we were to get started now with implementing this in
 Django, we would, say, in the case of the readthedocs.io links, either
 need to use looser regexes (possibly allowing one readthedocs site to
 redirect to another readthedocs site, etc) or need to write regexes for
 each readthedocs site (ouch?)

 I don't have a strong opinion, but I would say the former option (just
 remove the backreferences and allow looser matches) seems tolerable. We're
 perfectionists who don't mind using imperfect tools, right? :wink: We
 could then tighten up the regexes once someone submits a follow-up PR to
 Sphinx. A second opinion would be good to get before setting to work,
 though.

 I think the triage stage is set to Maybe because there might be objections
 to running this on CI vs. manually, but that doesn't bear directly on
 whether we should get the regexes written to use the new Sphinx feature.

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.c524fc6a15a17e43c251ec2727a989a5%40djangoproject.com.

Re: [Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
 Reporter:  Nick Pope|Owner:  Sarah
 Type:   |  Abderemane
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  dev
 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
-+-

Comment (by Sarah Abderemane):

 Nick Pope any news on this subject ?

-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.ab2d7e1b0c8e4314fe91a34b701a80eb%40djangoproject.com.

Re: [Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
 Reporter:  Nick Pope|Owner:  Sarah
 Type:   |  Abderemane
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  dev
 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
-+-

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: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.32f7351e3bde0bec64fd07da97375006%40djangoproject.com.

Re: [Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
 Reporter:  Nick Pope|Owner:  Sarah
 Type:   |  Abderemane
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  dev
 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
-+-

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: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.9631e0ad3a9031b90d9ab575556f602d%40djangoproject.com.

Re: [Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
 Reporter:  Nick Pope|Owner:  Sarah
 Type:   |  Abderemane
  Cleanup/optimization   |   Status:  assigned
Component:  Documentation|  Version:  dev
 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
-+-
Changes (by Sarah Abderemane):

 * owner:  nobody => Sarah Abderemane
 * status:  new => assigned


-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.0a44004893df0c0699619013dd925ccf%40djangoproject.com.

Re: [Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
 Reporter:  Nick Pope|Owner:  nobody
 Type:   |   Status:  new
  Cleanup/optimization   |
Component:  Documentation|  Version:  dev
 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
-+-
Changes (by Nick Pope):

 * stage:  Unreviewed => Someday/Maybe


-- 
Ticket URL: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.404007ad8be1cb205173e52620a03369%40djangoproject.com.

[Django] #32723: Add a GitHub action to run the Sphinx linkcheck builder.

[Django]

#32723: Add a GitHub action to run the Sphinx linkcheck builder.
-+-
   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: 
Django 
The Web framework for perfectionists with deadlines.

-- 
You received this message because you are subscribed to the Google Groups 
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/050.bb935063cbc4ecdd5e6ea90f73709d10%40djangoproject.com.