Story #6851

Updated by Brett Smith about 5 years ago

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: Possible fixes (engineering team to pick an implementation):

*
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.
* Reorder the install guide so that immediately after installing the API server, you install the shell server, and create standard objects. Update the shell server install guide to provide a different method to generate and use an API token that doesn't depend on Workbench. This is a little more involved, but it will probably be easier for users to debug any problems with the API server install from this point than it would be to go through Workbench.

Back