instructor-training icon indicating copy to clipboard operation
instructor-training copied to clipboard

Impact of file name changes on links

Open brownsarahm opened this issue 5 years ago • 13 comments

The upcoming revision will include significant reordering of content and renaming of episode files, so current links to material in this report will get broken.

Could we add, in the revision, a rendered table (that could live under extras) that helps people find what they were looking for?

And link to that on this repo's 404?

This would also be useful for when we reorient trainers.

brownsarahm avatar Feb 21 '21 16:02 brownsarahm

You're proposing a for-loop in the 404 template that is the syllabus page?

Denubis avatar Feb 22 '21 02:02 Denubis

Because it just came up for me and I was deeply puzzled -- the lesson won't render if there are broken internal links. To test this it must be run locally with jekyll server until all the internal links resolve.

Denubis avatar Feb 22 '21 03:02 Denubis

we'd fix the internal links; but external links (eg that people have saved, blog posts, etc) will be broken.

I'm proposing adding something like the following to the 404

We recently reorganized this lesson, a guide to what you may have been looking for is located 
on the [chages page](extras/changetable)

brownsarahm avatar Feb 22 '21 03:02 brownsarahm

Nice. And while we can link to the syllabus, that'll be renamed and whatnot, so just linking that is insufficient. I support this plan. Trying to maintain historical links strikes me as something that'll be a maintenance nightmare.

Denubis avatar Feb 22 '21 04:02 Denubis

Good idea! @fmichonneau or @zkamvar can you weigh in on feasibility for this re modifying the 404 message?

karenword avatar Feb 22 '21 17:02 karenword

We'll discuss this during our curriculum team meeting tomorrow and we'll get back to you. Thanks!

fmichonneau avatar Feb 23 '21 13:02 fmichonneau

From the outside, I struggle to find context, but here's what I can piece together:

This issue stems from #1217, which will be fixed by #1215, but that PR doesn't currently contain any content. Can someone point me to a place where I can see what the revisions will be?

zkamvar avatar Feb 23 '21 15:02 zkamvar

it's a major reivsion that is not done yet. episodes will be renamed, and coverage of topics will be moved from one episode to another. this summary table will be useful even in the latter case that doesn't address the broken links.

there are some piece of content in data lessons

brownsarahm avatar Feb 23 '21 20:02 brownsarahm

Thank you for the context!

zkamvar avatar Feb 23 '21 20:02 zkamvar

Noting here that there have been recent improvements to the 404 page in styles that we should consider in how we handle this: https://github.com/carpentries/styles/pull/578

brownsarahm avatar Apr 21 '21 14:04 brownsarahm

Now that the major update is merged, maybe we should return to this?

For example, some episodes have changed order and been renamed.

Everything internal is fine, but if someone was linking to 21-carpentries from somewhere else, that's now 15-carpentries. They'll get a 404 that doesn't help them find the information.

brownsarahm avatar Nov 04 '21 20:11 brownsarahm

for pages that have a direct mapping (like 21-carpentries to 15-carpentries), we could set up redirects, for the others, I'm not sure what else we could do

fmichonneau avatar Nov 05 '21 18:11 fmichonneau

There's a brute force solution here, which is to generate 301 redirect pages for all the old pages. Instead, would it be worth catching 404s https://jekyllrb.com/tutorials/custom-404-page/ and provide a custom 404 with the episode list in?

Denubis avatar Nov 05 '21 22:11 Denubis