[OpenStack-docs] Deprecation of custom semantic markup

Andreas Jaeger aj at suse.com
Sun Oct 11 17:22:04 UTC 2015


On 09/25/2015 11:46 PM, Steve Gordon wrote:
> ----- 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 possible variants and as Matt pointed out they have zero impact positive or otherwise on what we ultimately present to the reader.


I also suggest we do not take mass cleanups for these changes. If either 
form is fine, then no need to change them.

Especially as this will break all translations for existing content for 
no change in content at all. We should be friendly to the translators 
and help them,

Andreas
-- 
  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
    GF: Felix Imendörffer, Jane Smithard, Graham Norton,
        HRB 21284 (AG Nürnberg)
     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126




More information about the OpenStack-docs mailing list