Bug #5194
closed
[Documentation] User guide doesn't link to or acknowledge new "Getting Started" section
Added by Peter Amstutz about 10 years ago.
Updated about 10 years ago.
Estimated time:
(Total: 0.00 h)
Description
The User Guide has its own section labled "Getting started" which is confusing with the new (much better) "Getting Started" section.
- Description updated (diff)
Note about task
#5243:
This is a quick fix only.
- I disambiguated "user guide" vs "getting started" sections with some text
- I renamed "getting started" in the left navbar of the "user guide" to "welcome" to create less confusion
- I added "next steps" linking to the "user guide" in "getting started"
Review comments:
Looks much better and clears the confusion with disconnected "Getting started" sections. Just a few minor suggestions.
- nextsteps.html
- “Now that you’ve finished the Getting …” => can we say “Now that you’ve read the Getting …”
- “commandline” => can you make it “command line”
- User guide -> Welcome to Arvados
- “This is the User Guide. If you are new to Arvados and want to get started quickly, go to Getting Started instead.” => I think no need to say “This is the User Guide.”. I think saying something like “If you are new to Arvados, please read Getting Started guide for quick introduction to working with Arvados” would be nicer.
- Status changed from New to In Progress
- Assigned To set to Nancy Ouyang
- Target version changed from Bug Triage to 2015-02-18 sprint
- Status changed from In Progress to New
- Assigned To deleted (
Nancy Ouyang)
- Target version changed from 2015-02-18 sprint to Bug Triage
- I kept "finished" because hopefully they ran their first pipeline in addition to reading the guide
- fixed
- fixed
- Status changed from New to In Progress
- Target version changed from Bug Triage to 2015-02-18 sprint
- Status changed from In Progress to Resolved
Applied in changeset arvados|commit:9c8bad50218730ac2c640f8e1c00fd12f2f174e4.
Also available in: Atom
PDF