GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Fix broken links in the Devguide · Issue #681 · python/devguide

Fix broken links in the Devguide #681

New issue
Copy link
New issue
Copy link
Closed
#1013
Closed
Fix broken links in the Devguide#681
#1013
Copy link
Labels
good first issueNew contributorsNew contributorshelp wanted

Description

@Mariatta
Mariatta
opened on Apr 29, 2021
Issue body actions

Looks like the Link check step in the CI is broken. It has always been allowed to fail for a long time.
Would be great to fix them all.

Please see the output here:
https://github.com/python/devguide/runs/2463428458?check_suite_focus=true

While looking at the output, I noticed that pypy.org is listed as broken. I think that's the correct url though. I've filed the issue here:

pypy/pypy.org#23
Update: the url seems to work now.

But it would be good to look through the rest and update the urls accordingly.

Activity

Next
  1. Mariatta
    added
    help wanted
    good first issueNew contributorsNew contributors
    on Apr 29, 2021
  2. Mariatta commented on Apr 29, 2021

    @Mariatta
    Mariatta
    on Apr 29, 2021
    MemberAuthor
    More actions

    I think it would be great if link check becomes a required CI check, once we fixed all the urls.

    Reacted by Himanshu and Ezio Melotti
  3. himanshu007-creator commented on Apr 29, 2021

    @himanshu007-creator
    himanshu007-creator
    on Apr 29, 2021
    Contributor
    More actions

    Hi, i would like to fix the broken links. Please assign me this issue

  4. Mariatta commented on Apr 29, 2021

    @Mariatta
    Mariatta
    on Apr 29, 2021
    MemberAuthor
    More actions

    We don't assign issues to non core developers. You can just start creating the PR and we go from there.

  5. himanshu007-creator commented on Apr 29, 2021

    @himanshu007-creator
    himanshu007-creator
    on Apr 29, 2021
    Contributor
    More actions

    There are total 11 broken links. I have fixed 6 of 'em. But there are some links i would like to ask about.

    this and this link point to same website and this website just shows a white screen

    This metadata is not available as mentioned in issue

    This link doesn't work because the repo is either made private or deleted

    This website shows a 522 error

    I would like to know how should they be resolved.

  6. Mariatta commented on Apr 29, 2021

    @Mariatta
    Mariatta
    on Apr 29, 2021
    MemberAuthor
    More actions

    This website shows a 522 error

    Looks like gmane.org moved to https://gmane.io/

    This link doesn't work because the repo is either made private or deleted

    Yes the python/voters repo is a private repo that is available for Python core devs only. So it looks like we will have to allow that the linkcheck to be broken :( Is there a way to tell sphinx linkcheck to ignore this specific url?

    This metadata is not available as mentioned in issue

    Hmm yes, I also don't know what the correct URL is. It has been discussed previously in
    #456.

    Does anyone know where is the the Issue tracker for the tracker is? I thought that it's now being tracked at github.com/python/bugs.python.org, but this is the issue tracker for our own instance of it. It sounds like there is another issue tracker just for Roundup. But I don't know where that is.

    this and this link point to same website and this website just shows a white screen

    Those are Phillip Guo's websites. Seems like it's not active anymore. I'm not sure if they have another website now.
    Perhaps we can either remove the links, or point to a different resource.

    I understand that there are still broken links, however, if you can just start opening the pull request with the fixes that you've made, I think it would bring us to a better place already. We can continue fixing the broken links later.

  7. Mariatta commented on Apr 29, 2021

    @Mariatta
    Mariatta
    on Apr 29, 2021
    MemberAuthor
    More actions

    There is a way to tell linkcheck to ignore urls. The documentation is here:
    https://www.sphinx-doc.org/en/master/usage/configuration.html?highlight=linkcheck#options-for-the-linkcheck-builder

    Perhaps we need to add the python/voters url to it.

  8. hugovk commented on Apr 29, 2021

    @hugovk
    hugovk
    on Apr 29, 2021
    Member
    More actions

    Does anyone know where is the the Issue tracker for the tracker is? I thought that it's now being tracked at github.com/python/bugs.python.org, but this is the issue tracker for our own instance of it. It sounds like there is another issue tracker just for Roundup. But I don't know where that is.

    Is it https://issues.roundup-tracker.org/ ?

    Reacted by Mariatta
  9. Mariatta commented on Apr 30, 2021

    @Mariatta
    Mariatta
    on Apr 30, 2021
    MemberAuthor
    More actions

    Yes it looks like it.

  10. pratyaksh1610 commented on Jun 8, 2021

    @pratyaksh1610
    pratyaksh1610
    on Jun 8, 2021
    More actions

    I am new to open source . Can you guide me through the journey ?
    How can I resolve my first issue ?

  11. pratyaksh1610 commented on Jun 8, 2021

    @pratyaksh1610
    pratyaksh1610
    on Jun 8, 2021
    More actions

    @Mariatta

  12. jablonskidev commented on Jun 23, 2021

    @jablonskidev
    jablonskidev
    on Jun 23, 2021
    Contributor
    More actions

    @pratyaksh1610 If you're looking for guidance on how to find and fix your first issue, you can check out this resource: https://realpython.com/start-contributing-python/

  13. Noel-Voelin commented on Jul 15, 2021

    @Noel-Voelin
    Noel-Voelin
    on Jul 15, 2021
    More actions

    As far as I see, this issue is resolved. @Mariatta can you please close this or update with what is needed? Thanks!

  14. Mariatta commented on Jul 15, 2021

    @Mariatta
    Mariatta
    on Jul 15, 2021
    MemberAuthor
    More actions

    @Noel-Voelin there are still broken URLs in the linkcheck stage, and we need to get them fixed.

    The output is here: https://github.com/python/devguide/pull/727/checks?check_run_id=3079759235

    Some of the urls are not broken but rather restricted/hidden. You may need to adjust the config/settings such that linkcheck will ignore those urls. This doc describes how to set the options: https://www.sphinx-doc.org/en/master/usage/configuration.html?highlight=linkcheck#options-for-the-linkcheck-builder

    Hope this helps.

  15. 2 remaining items

  16. hugovk commented on Dec 12, 2021

    @hugovk
    hugovk
    on Dec 12, 2021
    Member
    More actions

    I would like you to check this link from documentation it says website can't be reached , I am not sure what site it points.

    https://t.me/pybr_i18n is a link to a Telegram channel. If you have Telegram installed on your phone, it opens the channel in the app. Tested just now on Android and it works.

  17. MohitMandalia commented on Dec 19, 2021

    @MohitMandalia
    MohitMandalia
    on Dec 19, 2021
    More actions

    I would like you to check this link from documentation it says website can't be reached , I am not sure what site it points.

    https://t.me/pybr_i18n is a link to a Telegram channel. If you have Telegram installed on your phone, it opens the channel in the app. Tested just now on Android and it works.

    Thanks.

  18. BrianWisniewski commented on Jan 19, 2022

    @BrianWisniewski
    BrianWisniewski
    on Jan 19, 2022
    More actions

    There also appears to be a broken link within both steps 5 and 7 here.

  19. hugovk commented on Jan 20, 2022

    @hugovk
    hugovk
    on Jan 20, 2022
    Member
    More actions

    https://github.com/python/voters/ is a private repo so only those with access can see it.

    I've created #793 to try and make it more obvious the repo is locked/private.

  20. slateny commented on Apr 14, 2022

    @slateny
    slateny
    on Apr 14, 2022
    Contributor
    More actions

    Some more broken links (copy the text then ctrl+f in the page) that I'm not too sure what to do:

    described in the buildbot documentation
    For an example, see the Py_NewRef (not broken, but misaligned - maybe use hash instead of Python version)
    The Tracker-discuss mailing list
    In Python’s Zulip Chat
    Extended bio (for Brett Cannon)

  21. hugovk commented on Apr 14, 2022

    @hugovk
    hugovk
    on Apr 14, 2022
    Member
    More actions

    described in the buildbot documentation

    Here's an archived version or perhaps you can find something relevant at https://docs.buildbot.net/current/ ?

    For an example, see the Py_NewRef (not broken, but misaligned - maybe use hash instead of Python version)

    Yeah, for these, I recommend fixing the #Lxxx-Lyyy bit, and then press the y key on your keyboard to get a permalink.

    The Tracker-discuss mailing list

    There's an archive but "Discussions about the bug tracker itself", referring to bpo, is irrelevant so I think this can be removed.

    In Python’s Zulip Chat

    I think this can be removed, but @Mariatta can confirm as it referred to her office hour in Zulip.

    (https://devguide.python.org/help) Extended bio (for Brett Cannon)

    Hi @brettcannon, this used to link to https://stackoverflow.com/cv/DrBrettCannon but it's 404. Would you like another link here, or have it removed?

  22. brettcannon commented on Apr 14, 2022

    @brettcannon
    brettcannon
    on Apr 14, 2022
    Member
    More actions

    @hugovk the link can just go.

    But I honestly don't know if that page is even worth keeping since not many people have filled it out and I know some of it is outdated (e.g. @kushaldas has changed employers).

  23. slateny commented on Apr 15, 2022

    @slateny
    slateny
    on Apr 15, 2022
    Contributor
    More actions

    Thanks for the links, Couldn't find a page exactly relevant to buildbot so I used the archieve, and I've updated the PR with all but the Zulip. If Zulip's no longer used, then should the entire section on it be removed?

    And as an aside, if it does get removed, it feels that the help page gets a bit bare and a good chunk of content overlaps with the communications page, so maybe some merging can be considered as well?

  24. hugovk commented on Apr 15, 2022

    @hugovk
    hugovk
    on Apr 15, 2022
    Member
    More actions

    I've never used Zulip, and I understand it's little used. People will have more luck getting help on the other channels so I'd say it makes sense removing the Zulop section.

    The aside:

    There's still quite a bit of stuff on the help page.

    To me the help page, "Where to Get Help", and the communications page, "Following Python’s Development", serve quite different purposes.

    Reacted by Stanley
  25. ezio-melotti commented on Apr 17, 2022

    @ezio-melotti
    ezio-melotti
    on Apr 17, 2022
    Member
    More actions

    I merged actions/toolkit#831.
    I was also looking at the the workflow that runs the make linkcheck:

    devguide/.github/workflows/ci.yml

    Lines 24 to 26 in ad524ba

    - name: Link check
    run: make linkcheck
    continue-on-error: true

    In https://github.com/python/devguide/runs/6050460764?check_suite_focus=true everything looks green, but the "Link check" step failed with

     build finished with problems.
    make: *** [Makefile:132: linkcheck] Error 1
    Error: Process completed with exit code 2.
    

    I understand that the step is allowed to fail (because of the continue-on-error), but the failure seems completely hidden unless you open the logs. I found actions/runner#2347 that discusses the issue, but there doesn't seem to be a clean solution -- just some workarounds.

    I was also exploring other ways to report the failure: steps.<step_id>.outcome can be used to obtain the status of the previous step (e.g. the link check), however I wasn't able to find a way to set the status description of the job so that it shows next to the name of the check.

    In the meanwhile I created actions/toolkit#840, and also found actions/toolkit#727 that is related to the continue-on-error

  26. kushaldas commented on Apr 17, 2022

    @kushaldas
    kushaldas
    on Apr 17, 2022
    Member
    More actions

    @hugovk the link can just go.

    But I honestly don't know if that page is even worth keeping since not many people have filled it out and I know some of it is outdated (e.g. @kushaldas has changed employers).

    Wondering if I should create a PR to update properly!!

    Reacted by Hugo van Kemenade
  27. hugovk commented on Apr 17, 2022

    @hugovk
    hugovk
    on Apr 17, 2022
    Member
    More actions

    @kushaldas Sure!

    @ezio-melotti I saw your comment at #727 (comment) and replied to it there: #727 (comment)

    Reacted by Ezio Melotti
  28. hugovk
    closed this as completedin #1013on Dec 25, 2022
  29. hugovk
    added a commit that references this issue on Dec 25, 2022

    Fix remaining broken links. (#1013)

    c0e1638
  30. kitarefake
    added a commit that references this issue on Jul 15, 2024

    Fix remaining broken links. (#1013)

    d5387a5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueNew contributorsNew contributorshelp wanted

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      You are visitor 01402520 — GeezerVison does not store the pages you look up.
      Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.