redhat-cop / redhat-cop/ocp4-helpernode
Slightly confusing mix of root user but "$" shell prompt
Nobody has claimed this yet.
- Dominant language
- Jinja
- Stars
- 358
- Forks
- 308
- PR merge metrics
- No merged PRs in 30d
Description
For this specific document I'm using, there is a confusing mix of root user logged in but all commands are run showing "$" shell prompt (which is typically non-root user).
The shell prompts should be changed to "#" but if that somehow confuses someone into thinking it's a comment and not a Linux shell command, then perhaps to be crystal clear every command should have something like this as the first part:
"[root@bastion] # " or "[root@helper] # "
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the specific document referred to in the issue and review its command examples. Change the root-user shell prompts from "$" to "#", or use explicit prompts such as "[root@bastion] #" and "[root@helper] #" where needed. Done means the document consistently identifies root shell commands without ambiguity.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100