Story #16601

Convert tutorial doc to markdown/textile & add to documentation site

Added by Peter Amstutz over 1 year ago. Updated about 1 year ago.

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 relationship:
Auto

Subtasks

Task #16763: Review 16601-new-tutorialResolvedPeter Amstutz

Associated revisions

Revision a0398ebd
Added by Peter Amstutz about 1 year ago

Merge branch '16601-new-tutorial' refs #16601

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <>

Revision b7c4169e (diff)
Added by Peter Amstutz about 1 year ago

Playground shell accounts enabled by default refs #16601

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <>

History

#1 Updated by Peter Amstutz over 1 year ago

  • Target version changed from 2020-08-12 Sprint to 2020-08-26 Sprint

#2 Updated by Peter Amstutz about 1 year ago

  • Target version changed from 2020-08-26 Sprint to 2020-09-09 Sprint

#3 Updated by Peter Amstutz about 1 year ago

  • Assigned To set to Peter Amstutz

#4 Updated by Peter Amstutz about 1 year ago

  • Category set to Documentation

#5 Updated by Peter Amstutz about 1 year ago

  • Target version changed from 2020-09-09 Sprint to 2020-09-23 Sprint

#7 Updated by Peter Amstutz about 1 year ago

  • Status changed from New to In Progress

#8 Updated by Lucas Di Pentima about 1 year 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 account should be a mailto: link.

#9 Updated by Peter Amstutz about 1 year 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 account should be a mailto: link.

Fixed.

16601-new-tutorial @ 65ed3963aabde8a25b1c4c0bb9ca858edf76c277

#10 Updated by Lucas Di Pentima about 1 year ago

This LGTM, please merge.

#11 Updated by Peter Amstutz about 1 year ago

  • Status changed from In Progress to Resolved

#12 Updated by Peter Amstutz about 1 year ago

  • Release set to 25

Also available in: Atom PDF