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

link to a forum search in a "troubleshooting installation" section #18

Closed
gregcaporaso opened this issue Nov 7, 2024 · 5 comments · Fixed by caporaso-lab/developing-with-qiime2#136
Assignees

Comments

@gregcaporaso
Copy link
Member

we'll do this here, instead of in docs (so closing qiime2/docs#560 in favor of this issue).

I think the best way for us to do this would be to link to an install (or similar) tag that we use on the forum, so we have some level of curation over what shows up when users click this link.

@lizgehret
Copy link
Contributor

lizgehret commented Nov 18, 2024

Hey @gregcaporaso - the install-faqs tag has been created (staff-only for adding/removing the tag from posts) - here's the URL for that tag: https://forum.qiime2.org/tag/install-faqs

Right now it's empty but I'm going to work on slowly adding old posts to this, and I've asked the mod team to add posts that seem useful as well (moving forward).

Let me know if you want me to open a PR with this linked off, or if you'd prefer to do it with any other changes you're making!

@gregcaporaso
Copy link
Member Author

gregcaporaso commented Dec 3, 2024

Thanks for working on this @lizgehret - the new tag seems great.

One thing we haven't figured out yet is where distribution-specific installation instructions are going to live, but I would like us to sort this out in this release cycle. Once we make that decision then we're ready to link this from that spot. Let's discuss in the engineering meeting this week. Two options I see right now are a Reference document that we link prominently from qiime2.org and use.qiime2.org, or in a distributions section on library.qiime2.org (that we link from the other spots).

@gregcaporaso
Copy link
Member Author

Though I guess in any case we should have a References > Installing QIIME 2 document in here. That could currently link to the install page in docs.qiime2.org, and include this link in a troubleshooting section. Feel free to add that now, or we can hold off and discuss.

@lizgehret
Copy link
Contributor

I think having that under a References section makes sense to me - let's discuss specifics during our meeting tomorrow, and then I can get started on that!

@lizgehret
Copy link
Contributor

closed by caporaso-lab/developing-with-qiime2#136

@lizgehret lizgehret assigned gregcaporaso and unassigned lizgehret Dec 12, 2024
@lizgehret lizgehret moved this from In Development to Needs Review in 2025.4 🌻 Dec 12, 2024
@gregcaporaso gregcaporaso moved this from Needs Review to Completed in 2025.4 🌻 Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants