Various thoughts/recommendations on documentation

[qiime2]

Various thoughts/recommendations on documentation

[jairideout]

"Directory of Methods [high]" and "Doc Version Archive [enhancement]" are complete and live on https://docs.qiime2.org.

The plugin/method directory (e.g. similar to QIIME 1's script index page) is at https://docs.qiime2.org/2.0.6/plugins/available/. The docs site has versioned docs for each QIIME 2 train release, and the wiki docs have been ported into the main site. Currently, you can provide the version number in the URL to view docs for a specific QIIME 2 version (e.g. https://docs.qiime2.org/2.0.5/), and we'll add a menu to easily switch between doc versions in the future.

See this forum post for more details about the latest website updates.

I'll edit the above post to indicate what items are completed.

[colinbrislawn]

Hey Jai, what's the best place to put tutorials?

For example, Greg's uchime-denovo tutorial is only on the fourms, but not on the docs. A forum member didn't find this tutorial and at first, neither did I!

Let me know the documentation strategy. Also let me know if I should move this to developer discussion on the forums.

EDIT: OK! See: https://forum.qiime2.org/t/whats-the-best-place-to-post-tutorials/

[jairideout]

Hi @colinbrislawn! Can you please post this on the forum's Developer Discussion category, that way we don't clutter up this issue with discussion?

[antgonza]

While I was searching for an issue about #297, which I couldn't find and created that, I came across this one. While reading this I see an overlap between some of these open points and the latest documentation changes we have done for Qiita. For example:

• Glossary
• Alpha diversity, with references to each method

Anyway, this can be the main guide for that tentative transition of documentation that we talked about: @gregcaporaso & @ebolyen

[colinbrislawn]

Is this the documentation lifecycle you are suggesting?

1. notice pattern of questions, and identify need for a guide / tutorial
2. write guide / tutorial and post it to the community tutorials forum
3. formalize guide and submit a PR to qiime2/docs/

Colin