Bug #7015

[Documentation] Refresh user guide

Added by Brett Smith about 4 years ago. Updated almost 4 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Start date:
10/14/2015
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
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

Task #7564: Connecting to virtual machine command in ssh-access-unix does not workResolved

Task #7565: go through /user/getting_started/ssh-access-windows.htmlResolved

Task #7581: arv-crunch-job permission deniedResolved

Task #7592: arv crunch job causes weird exitClosed

Task #7598: Review 7015-update-user-guideResolvedBryan Cosca


Related issues

Related to Arvados - Task #7563: [Workbench] Add IdentityFile to suggested SSH client configurationNew10/14/2015

Related to Arvados - Task #7570: [SDKs] a-r-p-i should write to stdout directly, rather than opening /dev/stdoutNew10/15/2015

Related to Arvados - Task #7571: Pipeline runner hangs after finishing the last job in webshellNew10/15/2015

Related to Arvados - Task #7577: arvados-jobs-java-bwa-samtools docker image python sdk is out of dateNew10/15/2015

Related to Arvados - Task #7499: [Workbench] Getting Started popup should link to Workbench's own public project listingNew10/09/2015

Associated revisions

Revision 8806f2d5
Added by Radhika Chippada about 4 years ago

refs #7015
Merge branch '7015-remove-pipeline-instance-from-recursive-arv-copy-doc'

Revision f0ea4324
Added by Bryan Cosca almost 4 years ago

Merge branch '7015-update-user-guide'

closes #7015

History

#1 Updated by Brett Smith about 4 years ago

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

#2 Updated by Brett Smith about 4 years ago

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

#3 Updated by Bryan Cosca about 4 years ago

  • Assigned To set to Bryan Cosca

#4 Updated by Bryan Cosca about 4 years ago

  • Assigned To deleted (Bryan Cosca)

#5 Updated by Brett Smith about 4 years ago

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

#6 Updated by Bryan Cosca about 4 years ago

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

#8 Updated by Bryan Cosca about 4 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.

#9 Updated by Bryan Cosca about 4 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.

#10 Updated by Brett Smith almost 4 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.

#11 Updated by Brett Smith almost 4 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.

#12 Updated by Nico César almost 4 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

#13 Updated by Bryan Cosca almost 4 years ago

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

Applied in changeset arvados|commit:f0ea4324260fb4dc6df693d9548285bb64b3b69f.

Also available in: Atom PDF