From d4b1e9f965344503494ae49b5c9c0dad52c21ed4 Mon Sep 17 00:00:00 2001 From: Helena Rasche Date: Mon, 18 Mar 2024 12:03:44 +0100 Subject: [PATCH 1/3] news post --- news/_posts/2024-03-18-url-persistence.md | 24 +++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 news/_posts/2024-03-18-url-persistence.md diff --git a/news/_posts/2024-03-18-url-persistence.md b/news/_posts/2024-03-18-url-persistence.md new file mode 100644 index 00000000000000..069a5ecc491fd9 --- /dev/null +++ b/news/_posts/2024-03-18-url-persistence.md @@ -0,0 +1,24 @@ +--- +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 2 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! From 55428c7a11ea6f54fa7ec1381a247fd694ef3857 Mon Sep 17 00:00:00 2001 From: Helena Rasche Date: Mon, 18 Mar 2024 12:05:29 +0100 Subject: [PATCH 2/3] how many --- news/_posts/2024-03-18-url-persistence.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/news/_posts/2024-03-18-url-persistence.md b/news/_posts/2024-03-18-url-persistence.md index 069a5ecc491fd9..cae7c9865b0dd2 100644 --- a/news/_posts/2024-03-18-url-persistence.md +++ b/news/_posts/2024-03-18-url-persistence.md @@ -22,3 +22,5 @@ So now we've added a new test to each GTN merge that checks URLs from the last 2 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 49 files that had been moved without proper redirections, and we've fixed them all. From 27e53cbd7a5552e9d0802c10ceb518e39cfe3756 Mon Sep 17 00:00:00 2001 From: Helena Rasche Date: Mon, 18 Mar 2024 12:27:39 +0100 Subject: [PATCH 3/3] update number, count --- bin/check-url-persistence.sh | 13 ++++++++++++- news/_posts/2024-03-18-url-persistence.md | 4 ++-- topics/admin/tutorials/upgrading/tutorial.md | 2 ++ 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/bin/check-url-persistence.sh b/bin/check-url-persistence.sh index 9072a71fd06028..f9c7372cbc2b8b 100755 --- a/bin/check-url-persistence.sh +++ b/bin/check-url-persistence.sh @@ -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||\n|g' | grep '[^<]*' -o | sed 's///;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||\n|g' | grep '[^<]*' -o | sed 's///;s/<\/loc>//' | sed 's|archive/2022-01-01|training-material|g' > /tmp/2022.txt fi @@ -7,10 +11,17 @@ if [[ ! -f /tmp/2024.txt ]]; then curl --silent https://training.galaxyproject.org/archive/2024-01-01/sitemap.xml | sed 's||\n|g' | grep '[^<]*' -o | sed 's///;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||\n|g' | grep '[^<]*' -o | sed 's///;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'| \ diff --git a/news/_posts/2024-03-18-url-persistence.md b/news/_posts/2024-03-18-url-persistence.md index cae7c9865b0dd2..b4546f5075104b 100644 --- a/news/_posts/2024-03-18-url-persistence.md +++ b/news/_posts/2024-03-18-url-persistence.md @@ -18,9 +18,9 @@ The GTN wants you to be able to rely on our URLs once you've added them to a pos 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 2 years to ensure that they are *all* still working. +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 49 files that had been moved without proper redirections, and we've fixed them all. +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! diff --git a/topics/admin/tutorials/upgrading/tutorial.md b/topics/admin/tutorials/upgrading/tutorial.md index 030e25289d300c..88eed7859ddc53 100644 --- a/topics/admin/tutorials/upgrading/tutorial.md +++ b/topics/admin/tutorials/upgrading/tutorial.md @@ -1,5 +1,7 @@ --- layout: tutorial_hands_on +redirect_from: +- /topics/admin/tutorials/upgrading/slides title: "Upgrading Galaxy" zenodo_link: ""