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

Anne Gentle anne at openstack.org
Mon Apr 21 13:15:44 UTC 2014


ALLCAPS sounds good to me! Shout it out!


On Mon, Apr 21, 2014 at 12:21 AM, Andreas Jaeger <aj at suse.com> wrote:

> In the Install Guide, we normally write VALUE all in caps in
> replaceables - with the exception of the hostname "controller". Is this
> a convention we want to use in the rest of the repos as well? I know we
> have different styles currently - including using "<value>" - but
> I would favor to have a common style used in all manuals and slowly
> converge to it.
>
> This was triggered by Diane asking me in
> https://review.openstack.org/#/c/89286/ to use
> "<replaceable>PASSWORD</replaceable>" and then reviewing
>
> https://review.openstack.org/#/c/89294/1/doc/common/section_cli_nova_customize_flavors.xml
> which uses for example "<replaceable>flavorName</replaceable>" in line 261.
>
> So, my question:
>
> Is everybody fine with me adding the all-caps convention to the
> Conventions page?
>
> Andreas
> --
>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: 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
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140421/031bf053/attachment.html>


More information about the Openstack-docs mailing list