theforeman / foreman-documentation

Documentation for the Foreman Project and its ecosystem
https://docs.theforeman.org
Creative Commons Attribution Share Alike 4.0 International
22 stars 95 forks source link

Run Hammer CLI as non-root user #3404

Open maximiliankolb opened 4 weeks ago

maximiliankolb commented 4 weeks ago

What changes are you introducing?

The dollar sign indicates that you do not need root priviledges to run Hammer CLI commands.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

the align with our existing convention: # for commands that you run as root; $ for all other commands.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

reproducer:

fd -e adoc -t f | xargs sed -i "s/^# hammer /$ hammer /g"

Checklists

Please cherry-pick my commits into:

github-actions[bot] commented 4 weeks ago

The PR preview for 7c3aaf14d388c8c0c43423e45a6445e9ee659be0 is available at theforeman-foreman-documentation-preview-pr-3404.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

apinnick commented 3 weeks ago

I am SO happy that you are making this change. The # prompt has been bothering me for ages!

apinnick commented 3 weeks ago

No CPs?

maximiliankolb commented 3 weeks ago

I would not cherry-pick this, but I can create more PRs if someone reviews it.