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

Summer Long slong at redhat.com
Tue Apr 22 07:30:35 UTC 2014


I'm +1 on the caps as well to make it obvious. 

Even more so in those cases where it functions without changing it. It might work, but not as they expect because they didn't think about it, and then they troubleshoot for days....

cheers, Summer
-- 
Summer Long 
OpenStack Documentation Lead 
Engineering Content Services 

Red Hat Asia Pacific 
Brisbane, Australia 
slong at redhat.com | irc: slong 

----- Original Message -----
> From: "Tom Fifield" <tom at openstack.org>
> To: openstack-docs at lists.openstack.org
> Sent: Tuesday, April 22, 2014 12:13:07 PM
> Subject: Re: [Openstack-docs] <replaceable>VALUE</replaceable> conventions?
> 
> 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'.
> 
> or storage_type=ephemeral - where 'ephemeral' is one of several valid
> types that you can choose.
> 
> Regards,
> 
> Tom
> 
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 



More information about the Openstack-docs mailing list