Bug #5194

[Documentation] User guide doesn't link to or acknowledge new "Getting Started" section

Added by Peter Amstutz about 5 years ago. Updated about 5 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
-
Category:
-
Target version:
Start date:
02/17/2015
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
-

Description

The User Guide has its own section labled "Getting started" which is confusing with the new (much better) "Getting Started" section.


Subtasks

Task #5243: Review branch 5194-quickfix-disambiguate-gettingstarted-sectionsResolvedRadhika Chippada

Associated revisions

Revision 9c8bad50
Added by Nancy Ouyang about 5 years ago

closes #5243, #5194 Merge branch '5194-quickfix-disambiguate-gettingstarted-sections'

History

#1 Updated by Peter Amstutz about 5 years ago

  • Description updated (diff)

#2 Updated by Nancy Ouyang about 5 years ago

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"

#3 Updated by Radhika Chippada about 5 years ago

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.

#4 Updated by Radhika Chippada about 5 years ago

  • Status changed from New to In Progress
  • Assigned To set to Nancy Ouyang
  • Target version changed from Bug Triage to 2015-02-18 sprint

#5 Updated by Nancy Ouyang about 5 years ago

  • 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

#6 Updated by Nancy Ouyang about 5 years ago

  • Status changed from New to In Progress
  • Target version changed from Bug Triage to 2015-02-18 sprint

#7 Updated by Anonymous about 5 years ago

  • Status changed from In Progress to Resolved

Applied in changeset arvados|commit:9c8bad50218730ac2c640f8e1c00fd12f2f174e4.

#8 Updated by Peter Amstutz about 5 years ago

This is great, thanks.

Also available in: Atom PDF