Open Stack

Heh.

Okay, I don't see the value in changing all of our source at this point.
Here's an example though.

This example of literal markup shows an inline "code" (ok, weak example)
marking. The nova user is not an option, but we do want to set it off as
it's the name we expect.

<para>Replace <replaceable>NOVA_PASS</replaceable> with the password you
chose for the <literal>nova</literal> user in the Identity service.</para>

In the example below, if we would use <option> instead of <literal> we
could one day automate a list of options described in the install guide:

<note><para>Comment out any <literal>auth_host</literal>,
<literal>auth_port</literal>, and <literal>auth_protocol</literal> options
because the <literal>identity_uri</literal> option replaces
them.</para></note>

I really don't think the difference is worth the trouble in changing the
current source though.

On Wed, Sep 17, 2014 at 11:00 AM, Matt Kassawara <mkassawara at gmail.com>
wrote:

> That... did not help me.
>
> On Wed, Sep 17, 2014 at 10:54 AM, Anne Gentle <anne at openstack.org> wrote:
>
>>
>>
>> On Wed, Sep 17, 2014 at 8:46 AM, Matt Kassawara <mkassawara at gmail.com>
>> wrote:
>>
>>> Do we also prefer <option> over <literal> for them?
>>>
>>
>> <option> is markup for inline options
>>
>> https://wiki.openstack.org/wiki/Documentation/DocBook_conventions#Configuration_options_.28inline.29
>>
>> <literal> is markup for inline code
>>
>> https://wiki.openstack.org/wiki/Documentation/DocBook_conventions#Code_or_data_.28inline.29
>>
>> Using <option> in this way would theoretically let us generate options
>> tables or pull out in other ways.
>>
>>
>>
>>>
>>> On Wed, Sep 17, 2014 at 8:06 AM, Anne Gentle <anne at openstack.org> wrote:
>>>
>>>>
>>>>
>>>> On Wed, Sep 17, 2014 at 4:36 AM, Andreas Jaeger <aj at suse.com> wrote:
>>>>
>>>>> Reviewing
>>>>> https://review.openstack.org/#/c/122027/
>>>>>
>>>>> I noticed the usage of "key" but I see "option" used in other guides
>>>>> when changing configuration files.
>>>>>
>>>>> Example:
>>>>> 1) "Set auth_uri key to..."
>>>>> 2) "Set auth_uri option to..."
>>>>>
>>>>> Is there a preferred way or is this something we use interchangeable?
>>>>>
>>>>>
>>>> I'd prefer we stick to the option term consistently (even if it's a key
>>>> that goes into that option).
>>>>
>>>>
>>>>> Andreas
>>>>> --
>>>>>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
>>>>>   SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>>>>>    GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG
>>>>> Nürnberg)
>>>>>     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272
>>>>> A126
>>>>>
>>>>> _______________________________________________
>>>>> Openstack-docs mailing list
>>>>> Openstack-docs at lists.openstack.org
>>>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>>>>
>>>>
>>>>
>>>> _______________________________________________
>>>> Openstack-docs mailing list
>>>> Openstack-docs at lists.openstack.org
>>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>>>
>>>>
>>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140917/e5ba4373/attachment.html>