Story #6851

[Documentation] Fix circular dependencies around installing the shell server

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

Status:
Resolved
Priority:
Normal
Assigned To:
Radhika Chippada
Category:
Documentation
Target version:
Start date:
08/05/2015
Due date:
% Done:

100%

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

Description

In the install docs, the ordering of installing a shell server has a few problems:

  • The documentation tells you to install Keep services first, but those pages tell you to run commands on a shell server to register those services in the API server.
  • The shell server installation guide points you to the user guide to get an API token. This tells you get the token from Workbench, but the documentation hasn't told you to install that yet.

The install guide should be ordered so that you can follow it linearly.

Solution: Reorder the install guide so that immediately after installing the API server, you install Workbench, the shell server, and standard objects, in that order. You won't be able to do much interesting with Workbench immediately after you install it, but at least it helps you test the SSO and API servers quicker, and you can use the API token it generates to install the shell server.


Subtasks

Task #6904: ReviewResolvedBryan Cosca

Associated revisions

Revision d6b2ead0
Added by Radhika Chippada about 4 years ago

closes #6851
Merge branch '6851-install-guide-flow'

History

#1 Updated by Radhika Chippada about 4 years ago

I recommend option 1, installing workbench before shell server.

First of, this would be quicker and would require less work.

Secondly, and most importantly, I think we should continue to improve our workbench to make it easier and easier for users to use our system. Our recent offerings such as webshell integration, git repo integration etc are some of the good examples. Unless we are trying to discourage using workbench, I do not see the need to go with option 2.

#2 Updated by Brett Smith about 4 years ago

  • Description updated (diff)
  • Assigned To set to Radhika Chippada
  • Story points set to 0.5

#3 Updated by Radhika Chippada about 4 years ago

  • Status changed from New to In Progress

#4 Updated by Radhika Chippada about 4 years ago

  • Status changed from In Progress to Resolved

Applied in changeset arvados|commit:d6b2ead0824fe6810917e5281b4feb969528eb46.

Also available in: Atom PDF