search

qiime2 / docs

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

IMP: updating conda installation code block to separate install and cleanup commands #541

Closed lizgehret closed 2 years ago

lizgehret commented 2 years ago

The code blocks mixed in with text in our install instructions are a bit confusing and can lead to accidental copying of the text in addition to just the install commands. I made some small tweaks to the HTML block that I think will improve readability.

Here is what the install code block per OS currently looks like for conda installation:

OSX:

Screen Shot 2022-09-13 at 11 24 41 AM

WSL:

Screen Shot 2022-09-13 at 11 24 50 AM

And here is what these code blocks will look like (tested and rendered locally) when the text is separated from the actual commands:

OSX:

Screen Shot 2022-09-13 at 11 22 11 AM

WSL:

Screen Shot 2022-09-13 at 11 22 19 AM

I couldn't find a way to include the copy widget in this block due to the fact that this isn't just a raw code block - it's HTML, which accommodates the multiple panes per OS. If anyone knows of a way to add in the copy widget, please feel free to add that in!

Oddant1 commented 2 years ago

Looks good to me. I like having the comments separated out like that because it will (probably) get people to actually read and understand what's going on a bit better.