Project

General

Profile

Actions

Task #2470

closed

Idea #2107: Recurring: ensure docs/tutorials are up-to-date with latest release.

Update docs for 2014-04-16 sprint

Added by Brett Smith about 10 years ago. Updated about 10 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Actions #1

Updated by Brett Smith about 10 years ago

  • Remaining (hours) changed from 8.0 to 3.0

Yesterday I made progress through the bulk of the tutorial. I got caught on one snag where I was following the latest documentation, but matching code hadn't been deployed yet. Tom was working on that last night, so I should be able to keep going from here.

Actions #2

Updated by Brett Smith about 10 years ago

  • Status changed from New to In Progress
Actions #3

Updated by Brett Smith about 10 years ago

  • Status changed from In Progress to Resolved
  • Remaining (hours) changed from 3.0 to 0.0

Pushed this branch upstream. 2490 is the review task.

Actions #4

Updated by Tom Clegg about 10 years ago

Lots of good wording and detail fixes. (Thanks! I like it when I'm not the only detail-nitpicker...)

doc/user/topics/tutorial-job1.html.textile.liquid
  • "... Crunch would immediately return the output from someone else's past tutorial run."
  • Hopefully this happened to you only because you have an administrator account, or some other user shared their job with you/everyone (which currently requires real dedication, but we'll have a Share UI soon).
  • We should say "could" instead of "would" and say something about "if they marked it as public". (It should be clear that everything is private by default.)
  • Another equally likely reason to include that no_reuse flag is that you might want to re-run it yourself while playing with the tutorials.
same file
  • "use the HEAD of the specified branch" -- I think we should be saying "tip", not "HEAD"...?
doc/user/tutorials/tutorial-new-pipeline.html.textile.liquid (I suspect we both edited this line at once)
  • "{output} is connected to the {input}" seems to me less clear than "{output} should be used as the {input}".
  • (And I still think the sentence "This is a dependency." just sounds like it's trying to get a bigger "teaching moment" than it deserves...)

Every other change looks like an improvement.

Things that (maybe) should improve more while we're here:

Other minor nitpicks/suggestions (and mostly out of scope of "updating for this sprint")
[edit: moved these things to #2505]

Actions #5

Updated by Brett Smith about 10 years ago

I've made a new push to implement your changes except the last section of out-of-scope stuff. I agree that a round of proper copyediting for stuff like that would be nice.

Actions #6

Updated by Tom Clegg about 10 years ago

Looks great, I say merge. (I moved the unrelated todo's to #2505.)

Actions

Also available in: Atom PDF