Skip to content

Commit

Permalink
Merge pull request #4842 from galaxyproject/pirate-pirarucu
Browse files Browse the repository at this point in the history
Add a news post bragging about our URL persistence
  • Loading branch information
hexylena authored Mar 18, 2024
2 parents 644b6a0 + 27e53cb commit 738a2a6
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 1 deletion.
13 changes: 12 additions & 1 deletion bin/check-url-persistence.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
#!/bin/bash
if [[ ! -f /tmp/2021.txt ]]; then
curl --silent https://training.galaxyproject.org/archive/2021-02-01/sitemap.xml | sed 's|<url>|\n|g' | grep '<loc>[^<]*</loc>' -o | sed 's/<loc>//;s/<\/loc>//' | sed 's|archive/2021-02-01|training-material|g' > /tmp/2021.txt
fi

if [[ ! -f /tmp/2022.txt ]]; then
curl --silent https://training.galaxyproject.org/archive/2022-01-01/sitemap.xml | sed 's|<url>|\n|g' | grep '<loc>[^<]*</loc>' -o | sed 's/<loc>//;s/<\/loc>//' | sed 's|archive/2022-01-01|training-material|g' > /tmp/2022.txt
fi
Expand All @@ -7,10 +11,17 @@ if [[ ! -f /tmp/2024.txt ]]; then
curl --silent https://training.galaxyproject.org/archive/2024-01-01/sitemap.xml | sed 's|<url>|\n|g' | grep '<loc>[^<]*</loc>' -o | sed 's/<loc>//;s/<\/loc>//' | sed 's|archive/2024-01-01|training-material|g' > /tmp/2024.txt
fi


if [[ ! -f /tmp/2099.txt ]]; then
curl --silent https://training.galaxyproject.org/training-material/sitemap.xml | sed 's|<url>|\n|g' | grep '<loc>[^<]*</loc>' -o | sed 's/<loc>//;s/<\/loc>//' > /tmp/2099.txt
fi

# No guarantees of API or data-file persistence
# 1fe4d7d92e5ea5a5794cbe741eadb96a74511261
cat /tmp/202*.txt | grep -v '/api/' | grep -v '/by-tool/' | grep -v '/hall-of-fame/' | \
cat /tmp/20*.txt | sort -u | \
grep -v '/api/' | grep -v '/by-tool/' | grep -v '/hall-of-fame/' | \
grep -v '/badges/' | \
grep --extended-regexp -v 'krona_?[a-z]*.html' | \
grep -v '/transcriptomics/tutorials/ref-based/faqs/rnaseq_data.html' | \
grep -v '/topics/data-management/' | \
grep -v 'training-material/tags/' | grep -v 'data-library'| \
Expand Down
26 changes: 26 additions & 0 deletions news/_posts/2024-03-18-url-persistence.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: "Cool URLs Don't Change, GTN URLs don't either."
layout: news
tags:
- gtn infrastructure
- new feature
contributions:
authorship:
- hexylena
infrastructure:
- hexylena
---

At the Galaxy Training Network we are *really* committed to ensuring our training materials are [Findable, Accessible, Interoperable, and Reusable]({% link faqs/gtn/fair_training.md %}).
This means that we want to make sure that the URLs to our training materials are persistent and don't change.
The GTN wants you to be able to rely on our URLs once you've added them to a poster or training material, without having to worry about them breaking in the future.

For a long time we relied on contributors ensuring that when files are merged, we add appropriate redirects to each moved file, however this isn't a very reliable system.
We'd recently also introduced [Persistent URLs (PURLs) to our lessons as well]({{ site.baseurl }}/news/2023/04/19/shortlinks.html) but that only helps our users going forward, it doesn't ensure we are meeting our earlier commitments.

So now we've added a new test to each GTN merge that checks URLs from the last 3 years to ensure that they are *all* still working.
If they aren't, the merge will fail and the contributor will need to fix the URLs before the changes can be accepted.

We'll be expanding how far back we check URLs in the future, but for now, this will help us ensure that our URLs are completely persistent!

By implementing this we discovered only 50 pages (out of ~5.3k GTN pages) that had been moved without proper redirections, and we've fixed them all!
2 changes: 2 additions & 0 deletions topics/admin/tutorials/upgrading/tutorial.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
layout: tutorial_hands_on
redirect_from:
- /topics/admin/tutorials/upgrading/slides

title: "Upgrading Galaxy"
zenodo_link: ""
Expand Down

0 comments on commit 738a2a6

Please sign in to comment.