Bug #4440

[Documentation] "Writing a Crunch script" is mysterious

Added by Nancy Ouyang about 3 years ago. Updated 9 months ago.

Status:
Closed
Priority:
Normal
Assigned To:
-
Category:
Documentation
Target version:
-
Start date:
11/05/2014
Due date:
% Done:

0%

Estimated time:
Story points:
-

Description

IN [[http://doc.arvados.org/user/tutorials/tutorial-firstscript.html]]
Everything after
"Next, create a submission job record. This describes a specific invocation of your script:"
doesn't make any sense.

In more detail:
What is a submission job record? What is the ~/the-job folder? Is this really related to writing a script, or is it just related to running the script? It's not clear that this command means I need to type something in, and it's very unclear how I'm supposed to determine what to type in, and it's not clear why I'm doing this.

The following portion, arv-crunch-job, seems to make a little more sense. I would explain what the $(cat ) is doing in arv-crunch-job, perhaps.


Related issues

Related to Arvados - Story #3044: [Documentation] Improve documentation for authoring crunch scriptsClosed

History

#1 Updated by Brett Smith about 3 years ago

  • Subject changed from documentation "Writing a Crunch script" is mysterious to [Documentation] "Writing a Crunch script" is mysterious
  • Category set to Documentation
  • Assigned To deleted (Nancy Ouyang)

#2 Updated by Ward Vandewege about 3 years ago

  • Target version changed from Bug Triage to Arvados Future Sprints

#3 Updated by Tom Clegg 9 months ago

  • Status changed from New to Closed

#4 Updated by Tom Clegg 9 months ago

  • Target version deleted (Arvados Future Sprints)

Also available in: Atom PDF