qiime2 / docs

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

Organize tutorials by theme #450

Open nbokulich opened 4 years ago

nbokulich commented 4 years ago

Improvement Description Organize the tutorials into thematic sections to facilitate navigation. This is important, especially as users may have difficulty finding appropriate tutorials based on a list of titles alone. Some suggested categories:

Current Behavior Tutorials are not well organized, the list can be a bit overwhelming

Proposed Behavior

  1. organize thematically?
  2. collapse tutorial section links so that they do not display by default on the tutorial TOC page (but can be unfurled with a click of a button to navigate headers within a tutorial)
  3. Other ideas?

Thanks to @jwdebelius for suggesting this change (this stems from a conversation with @jwdebelius and @mestaki on the forum)

jwdebelius commented 4 years ago

I think it might be good to have either a "quick start" page linked (moving pictures) and then the rest sound good to me. I liek the idea of "basics". Maybe rather than "advanced analyses" we want to describe them as plugin-specific, but I think either is good.

Thank you for doing this!

thermokarst commented 4 years ago

I really like this idea! We are going to start working on moving the tutorials over to the Library pretty soon (in the next few months 🤞). Since tutorials will be "user"-level submissions I wonder if it would be useful to have some kind of tagging feature, too, so that when new tutorials are added they can be automatically cross-linked into the organizational sections that matter.

nbokulich commented 4 years ago

some kind of tagging feature

I really like that idea! I see a recipe for chaos, though, if this is not enforced. A couple solutions:

  1. all tutorials should have a minimum of 1 tag (think of these as keywords) — or alternatively untagged tutorials are thrown in an "other tutorial" bin
  2. tags should be pre-defined, and users can request the library admin to create new tags. Otherwise inconsistent naming and synonyms could create chaos.

Maybe tutorials (and other resources?) can have multiple tags applied, then they can appear in multiple sections. This could be useful, e.g., for something like a filtering tutorial that may be relevant to more than one category, aiding discovery of key tutorials.