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

Links to Related Issues on example pages broken after sunset of classic GitHub projects #3113

Closed
howard-e opened this issue Sep 16, 2024 · 9 comments · Fixed by #3123
Closed
Labels
bug Code defects; not for inaccurate prose Infrastructure Related to maintaining task force and repo operations, processes, systems, documentation

Comments

@howard-e
Copy link
Contributor

howard-e commented Sep 16, 2024

Running npm run link-checker now gives the following on main and other branches. First noticed after merging #3108 but isn't caused by that change. Discovered 2 days prior.

result of script
npm run link-checker

> aria-practices@0.0.0 link-checker
> node ./scripts/link-checker.js

Checked 127 source files
Checking 129 external pages...
Checked 129 of 129 external pages
Found broken external link on content/patterns/accordion/examples/accordion.html:22:13, status was 404
Found broken external link on content/patterns/alert/examples/alert.html:23:13, status was 404
Found broken external link on content/patterns/alertdialog/examples/alertdialog.html:24:13, status was 404
Found broken external link on content/patterns/breadcrumb/examples/breadcrumb.html:22:13, status was 404
Found broken external link on content/patterns/button/examples/button_idl.html:23:13, status was 404
Found broken external link on content/patterns/button/examples/button.html:23:13, status was 404
Found broken external link on content/patterns/carousel/examples/carousel-1-prev-next.html:23:13, status was 404
Found broken external link on content/patterns/carousel/examples/carousel-2-tablist.html:23:13, status was 404
Found broken external link on content/patterns/checkbox/examples/checkbox-mixed.html:23:13, status was 404
Found broken external link on content/patterns/checkbox/examples/checkbox.html:23:13, status was 404
Found broken external link on content/patterns/dialog-modal/examples/datepicker-dialog.html:24:13, status was 404
Found broken external link on content/patterns/dialog-modal/examples/dialog.html:24:13, status was 404
Found broken external link on content/patterns/disclosure/examples/disclosure-faq.html:23:13, status was 404
Found broken external link on content/patterns/disclosure/examples/disclosure-image-description.html:23:13, status was 404
Found broken external link on content/patterns/disclosure/examples/disclosure-navigation-hybrid.html:23:13, status was 404
Found broken external link on content/patterns/disclosure/examples/disclosure-navigation.html:23:13, status was 404
Found broken external link on content/patterns/feed/examples/feed.html:19:13, status was 404
Found broken external link on content/patterns/grid/examples/advanced-data-grid.html:28:13, status was 404
Found broken external link on content/patterns/grid/examples/data-grids.html:27:13, status was 404
Found broken external link on content/patterns/grid/examples/layout-grids.html:25:13, status was 404
Found broken external link on content/patterns/link/examples/link.html:23:13, status was 404
Found broken external link on content/patterns/listbox/examples/listbox-collapsible.html:24:13, status was 404
Found broken external link on content/patterns/listbox/examples/listbox-grouped.html:24:13, status was 404
Found broken external link on content/patterns/listbox/examples/listbox-rearrangeable.html:25:13, status was 404
Found broken external link on content/patterns/listbox/examples/listbox-scrollable.html:24:13, status was 404
Found broken external link on content/patterns/menu-button/examples/menu-button-actions-active-descendant.html:23:13, status was 404
Found broken external link on content/patterns/menu-button/examples/menu-button-actions.html:23:13, status was 404
Found broken external link on content/patterns/menu-button/examples/menu-button-links.html:23:13, status was 404
Found broken external link on content/patterns/menubar/examples/menubar-editor.html:24:13, status was 404
Found broken external link on content/patterns/menubar/examples/menubar-navigation.html:23:13, status was 404
Found broken external link on content/patterns/meter/examples/meter.html:24:13, status was 404
Found broken external link on content/patterns/radio/examples/radio-activedescendant.html:23:13, status was 404
Found broken external link on content/patterns/radio/examples/radio-rating.html:23:13, status was 404
Found broken external link on content/patterns/radio/examples/radio.html:23:13, status was 404
Found broken external link on content/patterns/slider-multithumb/examples/slider-multithumb.html:23:13, status was 404
Found broken external link on content/patterns/slider/examples/slider-color-viewer.html:23:13, status was 404
Found broken external link on content/patterns/slider/examples/slider-rating.html:23:13, status was 404
Found broken external link on content/patterns/slider/examples/slider-seek.html:23:13, status was 404
Found broken external link on content/patterns/slider/examples/slider-temperature.html:23:13, status was 404
Found broken external link on content/patterns/spinbutton/examples/datepicker-spinbuttons.html:25:13, status was 404
Found broken external link on content/patterns/switch/examples/switch-button.html:23:13, status was 404
Found broken external link on content/patterns/switch/examples/switch-checkbox.html:23:13, status was 404
Found broken external link on content/patterns/switch/examples/switch.html:23:13, status was 404
Found broken external link on content/patterns/table/examples/sortable-table.html:23:13, status was 404
Found broken external link on content/patterns/table/examples/table.html:22:13, status was 404
Found broken external link on content/patterns/tabs/examples/tabs-actions.html:24:13, status was 404
Found broken external link on content/patterns/tabs/examples/tabs-automatic.html:23:13, status was 404
Found broken external link on content/patterns/tabs/examples/tabs-manual.html:23:13, status was 404
Found broken external link on content/patterns/toolbar/examples/toolbar.html:30:13, status was 404
Link checker found 49 broken links
@howard-e howard-e added bug Code defects; not for inaccurate prose Infrastructure Related to maintaining task force and repo operations, processes, systems, documentation labels Sep 16, 2024
@howard-e
Copy link
Contributor Author

howard-e commented Sep 16, 2024

The link checker is correctly flagging that the Related Issues links on the pattern examples are 404'ing because they no longer exist. Examples:

It also looks like only a "migrated" version of the tree and treegrid example exists:

@mcking65 @a11ydoer do you know what may have happened here? Were those removed in error or is there an alternative?

@howard-e howard-e changed the title Broken link-checker Missing Related Issues links for examples throws npm run link-checker error Sep 16, 2024
@mcking65
Copy link
Contributor

Oh no no no .... what has github done??? I can't find most of our projects!!

@css-meeting-bot
Copy link
Member

The ARIA Authoring Practices (APG) Task Force just discussed Where did our pattern-based GitHub projects go?.

The full IRC log of that discussion <jugglinmike> Topic: Where did our pattern-based GitHub projects go?
<jugglinmike> github: https://github.com//issues/3113
<jugglinmike> Matt_King: We had about 40 projects in the "classic" projects. GitHub has two kinds of projects. The "modern" projects are a mixed bag
<jugglinmike> Matt_King: Two of the classic projects are showing up in the current list of projects
<jugglinmike> Matt_King: There's the "combo box patterns and examples development project"
<jugglinmike> Matt_King: That looks to me like an old "classic" project
<jugglinmike> Matt_King: Why would they take them away before they've migrated them? And aren't they breaking the URLs?
<jugglinmike> howard-e: Maybe this is in progress. I don't think I saw the "combobox" patterns yesterday
<jugglinmike> howard-e: I'm also wondering if the migration happened and it's hidden at the repository level, but that it may exist at the W3C organization level
<jugglinmike> Matt_King: Perhaps. But it's annoying that when you're in one of these new projects, it's hard to go to any of the associated repositories. There are no links
<jugglinmike> Matt_King: But then by default, these new projects are private, but the old ones were public
<jugglinmike> Matt_King: It will be a lot of work to go in and make all the projects public again
<jugglinmike> howard-e: It looks like the old URLs redirect to the new ones
<jugglinmike> howard-e: That's how the link for "tree grid" is behaving, for example
<jugglinmike> howard-e: I shared that on in my earlier comment on the GitHub issue, as well
<jugglinmike> howard-e: This may be something to check in with Daniel about
<jugglinmike> Matt_King: One thing that's really cool is this view of the new projects is actually more accessible. They have good headings--one for each column, and one for each card in each column. That makes it really easy to navigate
<jugglinmike> Matt_King: Maybe we just need to learn more about this migration. Maybe there will be no action required, but we have a lot of broken links right now
<jugglinmike> Matt_King: Maybe we just wait?
<jugglinmike> Matt_King: GitHub includes a link to "learn more" about this process
<Matt_King> learn more about the migration: https://github.blog/changelog/2024-05-23-sunset-notice-projects-classic/
<jugglinmike> Matt_King: It looks like just two of our forty projects have been migrated. All the others are gone or hidden
<jugglinmike> Matt_King: It's hard to believe that the migration process would be this slow because it's so disruptive
<jugglinmike> Matt_King: But we should read the rest of their documentation about the migration
<jugglinmike> Matt_King: If, after reading it, we still have cause to suspect there is a problem, then we should report an issue to GitHub
<jugglinmike> Jem: How do we know this is related to the GitHub project migration?
<jugglinmike> Matt_King: Because if you try to visit a "classic" project, then GitHub displays a message about the migration. "Sunset notice: classic projects"
<jugglinmike> howard-e: It does for the very first time that you visit such a project, at least
<jugglinmike> Jem: Okay, your plan sounds good to me, Matt_King
<jugglinmike> Matt_King: Maybe this will go away in a couple days...
<jugglinmike> Zakim, end the meeting

@mcking65
Copy link
Contributor

@a11ydoer
Copy link
Contributor

Mentioning @keithamus @smockle from Github to look into if they can. Thanks in advance.

@howard-e
Copy link
Contributor Author

This is resolved now, with help from GitHub support over the weekend. The "missing" projects should now be present at https://github.com/w3c/aria-practices/projects?query=is%3Aopen again, and have been migrated to the v2 format.

@howard-e
Copy link
Contributor Author

Although this issue could be updated to reflect the need to update the currently referenced project links to their new location. Redirects are currently happening, like:

and it would be best to update those before they stop working, in maybe November(?).

@a11ydoer
Copy link
Contributor

Thanks for fixing these, @keithamus @smockle!

@mcking65 mcking65 changed the title Missing Related Issues links for examples throws npm run link-checker error Links to Related Issues on example pages broken after sunset of classic GitHub projects Oct 8, 2024
@css-meeting-bot
Copy link
Member

The ARIA Authoring Practices (APG) Task Force just discussed Where did our pattern-based GitHub projects go?.

The full IRC log of that discussion <jugglinmike> Topic: Where did our pattern-based GitHub projects go?
<jugglinmike> github: https://github.com//issues/3113
<jugglinmike> Matt_King: I want to celebrate
<jugglinmike> Matt_King: When we figured out what was going on here, we had a whole bunch of projects (over 20) that GitHub had essentially deprecated (or "sunset")
<jugglinmike> Matt_King: They were essentially gone
<jugglinmike> Matt_King: Everything for combobox, tree grid, tabs, and so on
<jugglinmike> Matt_King: Every page has a link to "related issues" and that is a specific project which contains all the issues that are related to that example and similar examples
<jugglinmike> Matt_King: That was quite a shocker
<jugglinmike> Matt_King: Those projects were supposed to be manually migrated by us if we wanted to keep them. I missed that, despite a prominent banner from GitHub
<jugglinmike> Matt_King: howard-e opened an issue with GitHub support and worked with them very diligently. They migrated all of those projects for us
<jugglinmike> Matt_King: The projects continue to remain public
<jugglinmike> Matt_King: For some reason, projects in the W3C GitHub organization are not public by default (that might be something that the W3C can and should change, by the way Daniel)
<jugglinmike> Daniel: I can double check with our systems team
<jugglinmike> Matt_King: If its possible for us to make the default "public" on a repository-by-repository basis, it would be very helpful for the ARIA-APG and ARIA-AT repositories
<jugglinmike> Matt_King: Anyway, we got them all back, which is awesome!
<jongund> I am back
<jugglinmike> Matt_King: It's just that the links we have on the website are old links. Those links automatically redirect to the new projects for now, but the redirection will end in November
<jugglinmike> Matt_King: I will take on reviewing that patch
<jugglinmike> Matt_King: I plan to get it merged as quickly as we can; hopefully before next week's meeting
<jugglinmike> jongund: I can help review, too
<jugglinmike> Matt_King: Sure. The patch is at https://github.com//pull/3123
<jugglinmike> Matt_King: If you find any problems, please comment there

mcking65 added a commit that referenced this issue Oct 22, 2024
Fixes issue #3113.

The links to "related issues" on each example page point to a GitHub project. There is a seprate GitHub project for each pattern or group of similar patterns.

The sunset of classic GitHub projects resulted in redirects from classic project URLs to the new migrated project URLs. This PR changes the links to point directly to the new project pages.

---------

Co-authored-by: Matt King <a11yThinker@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Code defects; not for inaccurate prose Infrastructure Related to maintaining task force and repo operations, processes, systems, documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants
@howard-e @mcking65 @a11ydoer @css-meeting-bot and others