[CentOS-docs] A Question of Style

On Tue, Dec 23, 2014 at 5:02 PM, Akemi Yagi <amyagi at gmail.com> wrote:

> On Tue, Dec 23, 2014 at 4:29 PM, PatrickD Garvey <
> patrickdgarveyt at gmail.com> wrote:
>
>>
>> I'm not referring to the username used by a particular person while using
>> a CentOS community resource. I'm trying to understand if the document
>> example should use an actual person's username (a security risk increase.
>> That's half that person's credentials.) or a pattern that refers to no one,
>> such as "username".
>>
>
> Perhaps you are thinking of the examples found on a page like this one:
>
>  http://wiki.centos.org/HowTos/I_need_the_Kernel_Source
>
> Depending on whether a command is supposed to be run by root or by a
> non-root user, the command line prompt changes between:
>
> [root at host]#
>
> and
>
> [user at host]$
>
> Akemi
>
>
Yes, that is about what I was expecting would be a standard use in
examples. Not only does it protect particular user credentials, but it
becomes something the reader uses as an indicator of what is happening in
the background, permissions are being used as appropriate.

I would make it more visually obvious with [username at host]$ because those
patterns are all the same width and can quickly be scanned into referring
to the same privileges.

Of course, an example for a well protected system would probably be showing
[username at host] $ sudo command whenever more powerful permissions are
required.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.centos.org/pipermail/centos-docs/attachments/20141223/07f5d890/attachment-0002.html>