Actions
Story #16601
closedConvert tutorial doc to markdown/textile & add to documentation site
Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Start date:
09/10/2020
Due date:
% Done:
100%
Estimated time:
(Total: 0.00 h)
Story points:
-
Release:
Release relationship:
Auto
Updated by Peter Amstutz over 4 years ago
- Target version changed from 2020-08-12 Sprint to 2020-08-26 Sprint
Updated by Peter Amstutz over 4 years ago
- Target version changed from 2020-08-26 Sprint to 2020-09-09 Sprint
Updated by Peter Amstutz over 4 years ago
- Target version changed from 2020-09-09 Sprint to 2020-09-23 Sprint
Updated by Peter Amstutz over 4 years ago
16601-new-tutorial @ 8f9a16c4e784b40e8661174fff32564e8c1c7f69
Updated by Peter Amstutz over 4 years ago
- Status changed from New to In Progress
Updated by Lucas Di Pentima over 4 years ago
Some observations while reviewing 8f9a16c :
- You mentioned on standup that the tutorial’s formatting is almost identical than the original document on purpose. I haven’t seen the doc but I’m seeing that if you resize the window horizontally, the text doesn’t flow with the window. This makes the headers multi-line as they have large font size. I personally don’t like having super long multi-line headers, so I wanted to point it out just in case it wasn’t on purpose.
- On “...and let’s them run the workflow by clicking the Run a process… button...” I think the button name could be put inside quotes or something similar.
- At step 4b there’re 3 links being rendered with their paths.
- All the screenshots include a note starting with “Screenshot of…” I think that’s redundant and can be removed.
- At step 6 there’re some a-c-r and bwamem-samtools-view mentions that could be formatted the same way as file names.
- At step 7 the link to the info@curii.com account should be a
mailto:
link.
Updated by Peter Amstutz over 4 years ago
Lucas Di Pentima wrote:
Some observations while reviewing 8f9a16c :
- You mentioned on standup that the tutorial’s formatting is almost identical than the original document on purpose. I haven’t seen the doc but I’m seeing that if you resize the window horizontally, the text doesn’t flow with the window. This makes the headers multi-line as they have large font size. I personally don’t like having super long multi-line headers, so I wanted to point it out just in case it wasn’t on purpose.
I set "max-width" to match the Google docs, so the lines break almost the same way. That's mostly what I meant about "matching the google doc formatting".
The super long multi-line headers are from Sarah's original document.
- On “...and let’s them run the workflow by clicking the Run a process… button...” I think the button name could be put inside quotes or something similar.
I marked up the things that are workbench buttons to actually look like workbench buttons.
- At step 4b there’re 3 links being rendered with their paths.
That's how it was in the original document but I agree they would be better as regular hyperlinks.
- All the screenshots include a note starting with “Screenshot of…” I think that’s redundant and can be removed.
Fixed.
- At step 6 there’re some a-c-r and bwamem-samtools-view mentions that could be formatted the same way as file names.
Fixed.
- At step 7 the link to the info@curii.com account should be a
mailto:
link.
Fixed.
16601-new-tutorial @ 65ed3963aabde8a25b1c4c0bb9ca858edf76c277
Updated by Peter Amstutz over 4 years ago
- Status changed from In Progress to Resolved
Actions