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

fixes broken RO Crate documentation links #4751

Merged
merged 1 commit into from
Feb 22, 2024

Conversation

SandyRogers
Copy link
Contributor

There were two typos in the RO Crate Intro tutorial, in URLs for the RO Crate docs webpages.

@github-actions github-actions bot added the fair label Feb 22, 2024
Copy link
Member

@hexylena hexylena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much @SandyRogers !

@hexylena
Copy link
Member

We currently don't do external link checking because there is so much link rot over time, but perhaps we can opt-in some tutorials like the RO-Crate ones where we know it's maintained, to ensure the links are checked. It's the second time we've had this situation so, clearly time to fix it :)

@hexylena hexylena merged commit 980e16d into galaxyproject:main Feb 22, 2024
3 checks passed
@SandyRogers SandyRogers deleted the patch-1 branch February 22, 2024 13:44
@SandyRogers
Copy link
Contributor Author

We currently don't do external link checking because there is so much link rot over time, but perhaps we can opt-in some tutorials like the RO-Crate ones where we know it's maintained, to ensure the links are checked. It's the second time we've had this situation so, clearly time to fix it :)

Thanks @hexylena !
Perhaps an existing github action for markdown link checking could be a fairly quick win ?

@hexylena
Copy link
Member

hexylena commented Feb 22, 2024

@SandyRogers it's an interesting suggestion! We have an existing pipeline step that checks internal links post build (and due to jekyll templating a lot of links include targets like {% link path/to/file.md %}) which might be marked as failures and would hvae to be ignored. Well, we'll look into it! Thanks for the tip

(we used to check all external links in the past but it was too noisy so if we re-enable it we want to be a bit more careful about focusing on things we know can be maintained.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants