prompts in command examples

Murray McAllister murray.mcallister at gmail.com
Thu Oct 2 22:30:06 UTC 2008


On Fri, Oct 3, 2008 at 2:21 AM, Karsten 'quaid' Wade <kwade at redhat.com> wrote:
>
> On Thu, 2008-10-02 at 08:17 +1000, Murray McAllister wrote:
>> Hi,
>>
>> The Red Hat documentation team recently had a discussion about using
>> prompts (such as "$" and "#") in command examples.
>>
>> Joshua "top-posting ftw" Wulf came up with the following, and everyone
>> agreed (I think...):
>
> IIRC, one person vehemently detracted.  My biggest concern here is
> getting a consistency across these documentation teams so we can work on
> common upstream content together.  That is much more important than my
> personal preference.
>
> Maybe we want to start a discussion of hashing out the difference in our
> style guides and making one common Fedora-based writing guide we can all
> reference, adding project- or commercial-specific content when working
> downstream.

Red Hat Content Services agreed on a usage. The current thing I am
working on is in Fedora, so if you could all let me know (preferably
before November) what you decide, I'll change it accordingly.

Cheers.




More information about the docs mailing list