<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Sun, Nov 9, 2014 at 1:56 PM, Anne Gentle <span dir="ltr"><<a href="mailto:anne@openstack.org" target="_blank">anne@openstack.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote"><span class="">On Sun, Nov 9, 2014 at 9:16 AM, Andreas Jaeger <span dir="ltr"><<a href="mailto:aj@suse.com" target="_blank">aj@suse.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">On Friday, a few folks from infra team sat together and discussed the<br>
style guide for the infra-manual (see<br>
<a href="https://etherpad.openstack.org/p/kilo-infra-manual" target="_blank">https://etherpad.openstack.org/p/kilo-infra-manual</a> ) as a followup to<br>
reviewing : <a href="https://review.openstack.org/#/c/107303/" target="_blank">https://review.openstack.org/#/c/107303/</a>  and<br>
<a href="https://review.openstack.org/#/c/107360/" target="_blank">https://review.openstack.org/#/c/107360/</a> . I took the action item to<br>
cover the problems as an enhancement to our style guide.<br>
<br>
Looking up the IBM style guide, I didn't found any explicit mentioning<br>
of this - so wrote up the following myself:<br>
<br>
======================================================================<br>
For documentation, we use semantic markup and let the toolchain format<br>
the text in a consistent and appropriate way. Thus, every occurence of<br>
a term, like a variable, should use the same markup.  The writing<br>
should be clear and markup consistent and thus a reader should easily<br>
know why a certain term is using a specific markup like boldface or<br>
italics. Explicit use of bold or italics is in general wrong.<br></blockquote><div><br></div></span><div>While it's currently considered wrong for our current toolchain, how do people using RST do mark up semantically? </div></div></div></div></blockquote><div><br></div><div>Sorry, found it: <a href="http://sphinx-doc.org/markup/inline.html#other-semantic-markup">http://sphinx-doc.org/markup/inline.html#other-semantic-markup</a></div><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr"><div class="gmail_extra"><div class="gmail_quote"><span class=""><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
======================================================================<br>
<br>
Please tell me whether it's accurate and specific enough for this case,<br>
<br>
Andreas<br>
<span><font color="#888888">--<br>
 Andreas Jaeger aj@{<a href="http://suse.com" target="_blank">suse.com</a>,<a href="http://opensuse.org" target="_blank">opensuse.org</a>} Twitter/Identica: jaegerandi<br>
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany<br>
   GF:Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB 21284 (AG Nürnberg)<br>
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126<br>
<br>
_______________________________________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org" target="_blank">OpenStack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
</font></span></blockquote></span></div><br></div></div>
</blockquote></div><br></div></div>