qiime2 / docs

https://docs.qiime2.org
BSD 3-Clause "New" or "Revised" License
21 stars 58 forks source link

"Exporting data" tutorial describes input artifacts as output artifacts #590

Closed AmandaBirmingham closed 3 weeks ago

AmandaBirmingham commented 1 month ago

Bug Description The "Exporting Data" tutorial correctly provides the input artifacts needed to run the example export commands, but labels them as "Output artifacts". This is the case for both examples given in the tutorial. The tutorial does not provide output file(s)/folders (which of course would not be artifacts for these commands).

Expected behavior Input artifacts are labeled as such rather than as "Output artifacts". In a perfect world, output file(s)/folders are provided so users can see what the export commands actually produce.

Screenshots Example of unexpected labeling:

Screenshot 2024-10-04 at 4 07 08 PM

Comments I suspect this is in some way due to the automated document processing used to generate the tutorial pages, so perhaps it cannot actually be fixed, but I thought it was worth noting.

gregcaporaso commented 3 weeks ago

Thanks for noticing and sharing that @AmandaBirmingham! This is an issue with our docs build. As we're transitioning how we manage the user docs, and phasing this site out in favor of https://use.qiime2.org, we're not going to fix for this release but rather just make sure that we don't introduce the same issue in the new docs.

Closing in favor of https://github.com/caporaso-lab/using-qiime2/issues/16.