Story #7996

[Documentation] Install guide guides people to install and configure keep-web

Added by Brett Smith almost 5 years ago. Updated almost 5 years ago.

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

100%

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

Description

  • Add node(s) and certificate(s) for keep-web in the Prerequisites, as applicable. (I don't know what's applicable.)
  • keep-web needs a page in the install guide. [It already has one.]
  • This page is linked in the TOC. [Uncomment the link in the current TOC.]
  • Add details to the Workbench configuration section such that file downloads are served through keep-web.

Subtasks

Task #8144: Add keep-web to TOCResolvedTom Clegg

Task #8145: Make sure workbench and keep-web doc pages are coherentResolvedTom Clegg

Task #8038: review 7996-keep-web-docResolvedTom Clegg

Associated revisions

Revision b512c815
Added by Tom Clegg almost 5 years ago

Merge branch '7996-keep-web-doc' closes #7996

History

#1 Updated by Brett Smith almost 5 years ago

  • Target version set to Arvados Future Sprints

#2 Updated by Brett Smith almost 5 years ago

  • Description updated (diff)
  • Story points set to 0.5

#3 Updated by Brett Smith almost 5 years ago

  • Target version changed from Arvados Future Sprints to 2016-01-06 sprint

#4 Updated by Tom Clegg almost 5 years ago

  • Assigned To set to Tom Clegg

#5 Updated by Brett Smith almost 5 years ago

  • Assigned To deleted (Tom Clegg)
  • Target version changed from 2016-01-06 sprint to Arvados Future Sprints

#6 Updated by Brett Smith almost 5 years ago

  • Target version changed from Arvados Future Sprints to 2016-01-20 Sprint

#7 Updated by Tom Clegg almost 5 years ago

  • Assigned To set to Tom Clegg

#8 Updated by Tom Clegg almost 5 years ago

  • Status changed from New to In Progress

#9 Updated by Tom Clegg almost 5 years ago

7996-keep-web-doc

Re: "Add details to the Workbench configuration section such that file downloads are served through keep-web"

I didn't change the Workbench page, so we still have a "go back to workbench and change config" step while installing keep-web.
  • It seems like the alternative is to say something on the Workbench page like "go read about keep-web and decide how you're going to set that up, then come back here to type your Workbench config", which seems (at least) as confusing/disruptive.
  • Getting Workbench alive unblocks a bunch of other testing and troubleshooting opportunities, so making it harder/slower to set it up seems like a move in the wrong direction.

#10 Updated by Radhika Chippada almost 5 years ago

Branch 7996-keep-web-doc lgtm.

As for the install guide issue, I also think that it would be confusing to talk about keep-web in workbench installation if we were to assume that the user is going through the docs in order. It seems like talking about workbench config inside the keep-web guide for the keep-web config portion seems fair.

#11 Updated by Tom Clegg almost 5 years ago

  • Status changed from In Progress to Resolved

Applied in changeset arvados|commit:b512c81509ce2264916482f01d0a968228d9c94e.

Also available in: Atom PDF