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

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

Closed
AmandaBirmingham opened this issue Oct 4, 2024 · 1 comment

Comments

@AmandaBirmingham
Copy link

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.

@github-project-automation github-project-automation bot moved this to Needs Triage in QIIME 2 - Triage 🚑 Oct 4, 2024
@lizgehret lizgehret moved this from Needs Triage to Needs Prioritization in QIIME 2 - Triage 🚑 Oct 10, 2024
@gregcaporaso
Copy link
Member

gregcaporaso commented Oct 24, 2024

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 caporaso-lab/using-qiime2#16.

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

No branches or pull requests

2 participants