Bug #7015
closed
[Documentation] Refresh user guide
Added by Brett Smith over 9 years ago.
Updated about 9 years ago.
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.
- Subject changed from Refresh user guide to [Documentation] Refresh user guide
- Description updated (diff)
- Category set to Documentation
- Target version changed from Arvados Future Sprints to 2015-09-02 sprint
- Assigned To set to Bryan Cosca
- Assigned To deleted (
Bryan Cosca)
- Target version changed from 2015-09-02 sprint to Arvados Future Sprints
- Status changed from New to In Progress
- Assigned To set to Bryan Cosca
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.
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.
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.
- Target version changed from Arvados Future Sprints to 2015-10-28 sprint
Moving to the current sprint for the branch to be reviewed.
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
- Status changed from In Progress to Resolved
- % Done changed from 80 to 100
Applied in changeset arvados|commit:f0ea4324260fb4dc6df693d9548285bb64b3b69f.
Also available in: Atom
PDF