Open Stack

On 08/14/2013 08:46 PM, Steve Gordon wrote:
> ----- Original Message -----
>> From: "Anne Gentle" <annegentle at justwriteclick.com>
>> To: "Steve Gordon" <sgordon at redhat.com>
>> Cc: "Andreas Jaeger" <aj at suse.com>, openstack-docs at lists.openstack.org
>> Sent: Wednesday, August 14, 2013 2:37:37 PM
>> Subject: Re: [Openstack-docs] programlisting language="bash" or language="INI" for config files?
>>
>> On Wed, Aug 14, 2013 at 1:25 PM, Steve Gordon <sgordon at redhat.com> wrote:
>>
>>> ----- Original Message -----
>>>> From: "Andreas Jaeger" <aj at suse.com>
>>>> To: openstack-docs at lists.openstack.org
>>>> Sent: Wednesday, August 14, 2013 2:05:29 PM
>>>> Subject: Re: [Openstack-docs] programlisting language="bash" or
>>> language="INI" for config files?
>>>>
>>>> On 08/14/2013 07:13 PM, Steve Gordon wrote:
>>>>> ----- Original Message -----
>>>>>> From: "Andreas Jaeger" <aj at suse.com>
>>>>>> To: openstack-docs at lists.openstack.org
>>>>>> Sent: Wednesday, August 14, 2013 12:35:25 PM
>>>>>> Subject: [Openstack-docs] programlisting language="bash" or
>>> language="INI"
>>>>>>         for config files?
>>>>>>
>>>>>> Stephen Gordon asked in reviewing https://review.openstack.org/41861:
>>>>>>
>>>>>> "Line 146:                                 <programlisting
>>>>>> language="bash">[DEFAULT]
>>>>>> Is bash actually the correct directive for these, I'm not super
>>> familiar
>>>>>> with clouddocs-maven's highlight functionality but other tools I have
>>>>>> worked with have one specifically for the INI file format?"
>>>>>>
>>>>>> Looking at the wiki, I do not see INI mentioned - and don't see it
>>> used
>>>>>> anywhere. So, is there an INI option we should use or should we
>>> continue
>>>>>> using "bash"?
>>>>
>>>>
>>>> Diane answered it with this link as part of the review, so "bash" is
>>> fine:
>>>>
>>> https://github.com/rackerlabs/clouddocs-maven-plugin/#new-features-and-changes-1
>>>>
>>>> Thanks Diane!
>>>
>>> The other option would be to not provide the language attribute at all,
>>> which is semantically correct and what I see in most examples of INI
>>> content I can find in openstack-manuals. If there's an expectation that for
>>> INI files they will always be marked up as Bash then I think it should be
>>> added to the Conventions and applied uniformly:
>>>
>>
>> When you say the INI files you mean nova.conf, cinder.conf, and so on
>> right?
> 
> Yes, I refer to them as INI files simply because that's the syntax they use (intentionally).
> 
>> I believe should not be marked language="bash"
>> linenumbering="unnumbered" but simply <programlisting> -- is that okay with
>> everyone?
> 
> That's OK with me and mirrors the vast majority of the occurrences I could find in the repository.

I was under the impression that moving forward they should be added.
>>>
>>>
>>> https://wiki.openstack.org/wiki/Documentation/Conventions#Code_or_data_.28block.29
>>
>>
>> Feel free to change this wiki page to reflect the outcome of this
>> discussion, and thanks all for updating it as we shape these conventions.

Yes, I agree we should document this.

> I'll wait for further responses from Andreas, or anyone else for that matter, before doing this.


Diane just suggested to add language="bash" to some places - let her
chime in as well.

I can remove them again where I introduced them if that's the consensus.

I agree with Steve that bash is not correct but it highlights the html
nicely - so using it is a hack ;)

Could we get the style sheet to be enhanced for INI and use that moving
forward?

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