Details
-
Type:
Improvement
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Stack Documentation and UX
-
Labels:None
-
Story Points:1
-
Epic Link:
-
Sprint:Alert Production F16 - 10
-
Team:Alert Production
Description
The instructions for using public-key authentication with lsst-dev assume the user has OpenSSH. While this does not prevent users from translating the instructions to their own SSH software, it does cause a confusing bug if the user isn't aware that OpenSSH (or, specifically, the ~/.ssh/authorized_keys file) only accepts one-line keys and not the more common multi-line PEM format.
I propose that a note be added to the end of "1. Generate a key pair" warning non-OpenSSH users to make sure their public key is in the one-line format.
I'd like a quick review of this change. It puts the original text in a more platform-independent context, but doesn't alter it otherwise.