Project

General

Profile

Actions

Bug #7015

closed

[Documentation] Refresh user guide

Added by Brett Smith over 8 years ago. Updated over 8 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Bryan Cosca
Category:
Documentation
Target version:
Story points:
2.0

Description

For the entire Arvados user guide, look for documentation that is out-of-date, and prepare a branch that brings those parts up-to-date.

The tutorial pages are specifically a priority. Please actually follow their steps to make sure that it all works, and that sample outputs you get reasonably match what's documented. Any mismatches there are candidates for updating.


Subtasks 5 (0 open5 closed)

Task #7564: Connecting to virtual machine command in ssh-access-unix does not workResolved10/14/2015Actions
Task #7565: go through /user/getting_started/ssh-access-windows.htmlResolved10/14/2015Actions
Task #7581: arv-crunch-job permission deniedResolved10/15/2015Actions
Task #7592: arv crunch job causes weird exitClosed10/16/2015Actions
Task #7598: Review 7015-update-user-guideResolvedBryan Cosca10/16/2015Actions

Related issues

Related to Arvados - Task #7563: [Workbench] Add IdentityFile to suggested SSH client configurationClosed10/14/2015Actions
Related to Arvados - Task #7570: [SDKs] a-r-p-i should write to stdout directly, rather than opening /dev/stdoutNewActions
Related to Arvados - Task #7571: Pipeline runner hangs after finishing the last job in webshellNewActions
Related to Arvados - Task #7577: arvados-jobs-java-bwa-samtools docker image python sdk is out of dateNewActions
Related to Arvados - Task #7499: [Workbench] Getting Started popup should link to Workbench's own public project listingClosed10/09/2015Actions
Actions #1

Updated by Brett Smith over 8 years ago

  • Subject changed from Refresh user guide to [Documentation] Refresh user guide
  • Description updated (diff)
  • Category set to Documentation
Actions #2

Updated by Brett Smith over 8 years ago

  • Target version changed from Arvados Future Sprints to 2015-09-02 sprint
Actions #3

Updated by Bryan Cosca over 8 years ago

  • Assigned To set to Bryan Cosca
Actions #4

Updated by Bryan Cosca over 8 years ago

  • Assigned To deleted (Bryan Cosca)
Actions #5

Updated by Brett Smith over 8 years ago

  • Target version changed from 2015-09-02 sprint to Arvados Future Sprints
Actions #6

Updated by Bryan Cosca over 8 years ago

  • Status changed from New to In Progress
  • Assigned To set to Bryan Cosca
Actions #8

Updated by Bryan Cosca over 8 years ago

Notes on #7565:

Step 2 - Creating a Public Key

Define what type if key to generate. SSH-2 RSA is by default. Other options are SSH-1 (RSA) and SSH-2 DSA.

Actions #9

Updated by Bryan Cosca over 8 years ago

branch 7015-update-user-guide is up for review on c31abb

I went through the entire user guide and either filed bugs on things that didn't work as expected (attached to the this ticket) or fixed the documentation. I'm not sure what else I can do here, its possible I missed some things but I tried to do a thorough read/test of everything.

I made sure the Develop a new pipeline section works as extended as specified in the description. I made one change in note #7 that I think people were running into.

Actions #10

Updated by Brett Smith over 8 years ago

Bryan Cosca wrote:

I went through the entire user guide and either filed bugs on things that didn't work as expected (attached to the this ticket)…

Thanks. I'm going to break these off the ticket so that we can track them through Redmine backlogs, and make sure they get addressed appropriately. I'll add relationships so we remember where they came from, though.

Actions #11

Updated by Brett Smith over 8 years ago

  • Target version changed from Arvados Future Sprints to 2015-10-28 sprint

Moving to the current sprint for the branch to be reviewed.

Actions #12

Updated by Nico César over 8 years ago

reviewing c31abb2aa1a1e4493ee1f3ed2d63163cf7b4cafb

doc/user/index.html.textile.liquid line 13 has an extra space at the end. delete it before merging.

there changes aren't that big. and LGTM...

I trust that the triple escape "\\\" is OK in doc/_includes/_tutorial_bwa_sortsam_pipeline.liquid:

-                    "@RG\\tID:group_id\\tPL:illumina\\tSM:sample_id",
+                    "@RG\\\tID:group_id\\\tPL:illumina\\\tSM:sample_id",

ready for merge in my opinion

Actions #13

Updated by Bryan Cosca over 8 years ago

  • Status changed from In Progress to Resolved
  • % Done changed from 80 to 100

Applied in changeset arvados|commit:f0ea4324260fb4dc6df693d9548285bb64b3b69f.

Actions

Also available in: Atom PDF