Open Stack

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

I think that's a good approach.

L

On 26/09/15 08:11, Matt Kassawara wrote:
> I agree on allowing either way without ramifications of a negative rev
iew.
> We should consider changing the RST conventions to say "follow the sta
ndard
> Sphinx/RST conventions" (provide a link) and add just a few things to
> maintain consistency and prevent specific issues with our workflow and
> publishing mechanism. For example, Sphinx/RST seems to accept any sequ
ence
> of characters to determine chapter, section, and subsections, but for
> consistency we prefer to use overline/underline "=" for chapters, unde
rline
> "~" for sections, and underline "-" for subsections.
> 
> On Fri, Sep 25, 2015 at 3:46 PM, Steve Gordon <sgordon at redhat.com> wro
te:
> 
>> ----- Original Message -----
>>> From: "Andreas Jaeger" <aj at suse.com>
>>> To: "Matt Kassawara" <mkassawara at gmail.com>
>>>
>>> On 09/25/2015 06:27 PM, Matt Kassawara wrote:
>>>> Doh, bad word choice. How about... lesser semantic markup that adds
>>>> complexity to the code without appreciable benefit to our audience 
in
>>>> the output.
>>>>
>>>
>>> What about the following (and feel free to enhance that list):
>>>
>>> We have no preference for :file:`some-file` or ``some-file``, both
>>> options will be accepted and neither gets a -1.
>>>
>>> Andreas
>>
>> I'd be +1 on this, I can't for the life of me remember all the possib
le
>> variants and as Matt pointed out they have zero impact positive or
>> otherwise on what we ultimately present to the reader.
>>
>> -Steve
>>
> 
> 
> 
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 


- -- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQEcBAEBAgAGBQJWCGvGAAoJELppzVb4+KUyzxIIAJqp4GxGyfvY/9lsWSalHOil
NdrjMQ9yOfHwQ4AMrIjQzi7MPWxKihtRaM38h5ri1P5BdRMTxgUPD1GQnts9iRxi
c7wsTMVAGEdK5PO8ZX0BhaHTcEcFuxDJfGVKFsGwkmdAoVPV+B9RESkwI37M/3IE
NdS49ZGdDIVyXB8EnQYl6N4imWuDz3TqLtOOOSy0V2SQADa8Remu1xwtQJ/uwYcF
s70s0xtfl2Lw6cLMKyjl+0PiDIxxonR03ERI88V5y+HMW6fLmVrDcs4Sd/CJ0cKu
OI94TaIPYAW4LJF4Qv0nz8rax0Kjbc4lvnDcsQHushZPdIedk0U24oMkkBcuOxc=
=BY52
-----END PGP SIGNATURE-----