Add explainer text to sgr engine add password prompt#709
Merged
Conversation
As an "impatient onboarder" it wasn't immediately obvious to me the implications of `sgr engine add` prompting for a password. I first suspected `sgr` wanted root and believed it was a sudo prompt. It seems reasonable to add some explainer text here, so as to assuage any worries/confusion as to which password is expected/how it gets used.
onpaws
force-pushed
the
tweak-sgr-engine-add-prompt
branch
from
4494b6b to
4b98274
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As an "impatient onboarder" it wasn't immediately obvious to me the implications of
sgr engine addprompting for a password here.I actually first thought
sgrneeded root privs to do whatever permission-requiring orchestration it needed to do, and nearly entered my OS password, which would have been persisted in plain text to.sgconfig.I guess it's arguably subjective, but basically the motivation for this PR is that it seemed reasonable to add a bit of explainer text to this prompt, so as to help future users avoid making the same mistake.