Need URL to Latest Qiime2 Docs
dhakim87 opened this issue · comments
Improvement Description
I'm adding a link out to the qiime2 documentation page from within the microsetta initiative site. I want to direct users to the latest documentation, but the latest documentation changes all the time. That is:
I currently send users out to https://docs.qiime2.org/2020.6/tutorials/moving-pictures/#taxonomic-analysis
I can replace with https://docs.qiime2.org/2021.2/tutorials/moving-pictures/#taxonomic-analysis, but that will be obsolete very soon.
Current Behavior
Links to the documentation go stale monthly
Proposed Behavior
Can you expose a new url at:
"https://docs.qiime2.org/latest/tutorials/moving-pictures/#taxonomic-analysis" and have it redirect the end user to the latest documentation? It will still break if someone removes the moving-pictures tutorial, but at least it won't tell the end user the link is out of date forcing me to update on my end.
Hey @dhakim87 - this is on our radar, although there might be some other things that shake up with it - tutorials and usage docs will likely move over to https://library.qiime2.com, but same basic idea. One minor point, we don't release QIIME 2 monthly anymore, we only did that in 2017 when we were sprinting on version 1.0 - nowadays we release ~quarterly, but, point taken!
In the meantime, if you have a particular URL that you want short-linked, you can add a PR to https://github.com/qiime2/data302 that adds a permanent redirect from something like https://data.qiime2.org/latest-mp-taxa-analysis to the latest doc URL, that would be great. Then, when new docs come out, we can just update what the URL points to. Not a permanent or long-term solution, but hopefully this might help cut down on churn while we whittle away at Library.
covered by #290