fix: improve UX of post-install group instructions - #3297
Open
skoll43 wants to merge 1 commit into
Open
Conversation
Replaced the hardcoded <insert your username here> placeholder with an escaped \$USER variable. This allows the output command to be directly copy-pasted into the terminal without manual editing.
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
1 participant
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.
Replaced the hardcoded placeholder with an escaped $USER variable. This allows the output command to be directly copy-pasted into the terminal without manual editing.
What does this PR do?
This PR improves the quality-of-life for the post-install instruction by replacing the hardcoded
<insert your username here>placeholder with the$USERenvironment variable.Why is this needed?
Currently, users are prompted with:
sudo usermod -aG clab_admins <insert your username here> && newgrp clab_adminsThis requires the user to manually backspace and type their username before executing.
By changing the output to:
sudo usermod -aG clab_admins $USER && newgrp clab_adminsThe user can simply copy and paste the string into their terminal. Their local shell will seamlessly evaluate
$USERto their active account.Note: The variable is escaped as
\$USERin the echo statement so it prints the literal string rather than evaluating torootduring the sudo installation process.