[Openstack-docs] <replaceable>VALUE</replaceable> conventions?

Andreas Jaeger aj at suse.com
Tue Apr 22 07:28:22 UTC 2014


On 04/22/2014 04:13 AM, Tom Fifield wrote:
> On 22/04/14 01:29, Andreas Jaeger wrote:
>> On 04/21/2014 03:15 PM, Anne Gentle wrote:
>>> ALLCAPS sounds good to me! Shout it out!
>>>
>>
>>
>> I've updated the Conventions wiki page,
> 
> one exception, perhaps?
> 
> Where the replacable bit is actually usable as-is, can it be left in the
> most useful case?
> 
> For example, host=controller. DNS names are typically lower-case, and I
> can believe a lot of people will call their controllers 'controller'.

Yeah, we use this in the Install Guide.

> or storage_type=ephemeral - where 'ephemeral' is one of several valid
> types that you can choose.

I've update the wiki:

https://wiki.openstack.org/wiki/Documentation/Conventions#Variable_text

Feel free to further enhance.

Thanks,
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



More information about the Openstack-docs mailing list