Open Stack

On Tue, Mar 31, 2015 at 4:11 AM, Bernd Bausch <berndbausch at gmail.com> wrote:

> I believed this is answered in
> https://wiki.openstack.org/wiki/Documentation/Markup_conventions:
>
>
>
> *RST*: Use :command:, ``, :option:, or :samp:. :samp: allows to mark
> variables with curly braces.
>
>
>
> Double backtick yes, double asterisk no.
>


Thanks Bernd! Yes, we definitely need to stick to the documented
conventions and be consistent. Thanks for bringing it up Olga.

Thanks,
Anne


>
>
> *From:* Olga Gusarenko [mailto:ogusarenko at mirantis.com]
> *Sent:* Tuesday, March 31, 2015 5:52 PM
> *To:* openstack-docs
> *Subject:* [OpenStack-docs] [User Guides] Conversion of the <command> tag
>
>
>
> Hi to all!
>
> We have contrary opinions regarding the translation of the <command> XML
> tag to RST.
>
> It will be great to have a single solution for everyone to keep the
> consistency in the docs.
>
>
>
> Should the commands be wrapped in double asterisk symbol that stands for
> the bold text (as the commands in the xml files are bold when the sources
> are built)?
>
> Or should they be wrapped in double backtick symbol that stands for the
> monospaced text? And if so, we will have the same output for commands,
> options, parameters  and literal.
>
> So, should it be:
>
> a. **command**
>
>        or
>
> b. ``command``
>
>
>
> Thanks for your answers in advance!
>
> Best regards,
>
> Olga
>
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>


-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150331/f509fab4/attachment.html>