Open Stack

Whoops, I noticed this discussion went off-list.

On Sat, May 24, 2014 at 8:44 PM, Matt Kassawara <mkassawara at gmail.com>wrote:

> I can't find any requirements for IDs outside of sections. For
> consistency, I think we should require IDs on figures and tables too.
>
> P.S. - I just noticed that our thread went off-list. Should I put it back?
>
>
> On Sat, May 24, 2014 at 7:47 PM, Diane Fleming <
> diane.fleming at rackspace.com> wrote:
>
>>  Yes, sections are not named consistently. Are id's required on figures
>> and tables? Or only if you cross-ref them? (I don't remember.)
>>
>> Sent from my iPhone
>>
>> On May 24, 2014, at 11:15 AM, "Matt Kassawara" <mkassawara at gmail.com>
>> wrote:
>>
>>   Thanks! I took a look and mostly found consistency with bk_* and ch_*,
>> but sections often lack section_*. Many figures and tables often lack IDs.
>>
>>
>> On Sat, May 24, 2014 at 9:33 AM, Diane Fleming <
>> diane.fleming at rackspace.com> wrote:
>>
>>>  Matt, look at openstack-manuals -> user-guide, config ref, common, or
>>> the admin guide - i think all those use a consistent naming style. Chapters
>>> ch_*, sections section_*, books bk_*. I do not remember what we used for
>>> images and tables - but look there for existing conventions.
>>>
>>> Sent from my iPhone
>>>
>>> On May 24, 2014, at 9:46 AM, "Matt Kassawara" <mkassawara at gmail.com>
>>> wrote:
>>>
>>>   Would consistently indicating type within an ID help clarify
>>> references? For example, chapter IDs always start with "ch_", section IDs
>>> always start with "sec_", figure IDs start with "fig_", etc.
>>>
>>>
>>> On Thu, May 22, 2014 at 5:58 PM, Matt Kassawara <mkassawara at gmail.com>wrote:
>>>
>>>> I found some inconsistencies with filenames and chapter/section IDs
>>>> while auditing the Installation Guide. I thought I found some conventions
>>>> while updating the guide for Icehouse, but can't find them now. If they
>>>> exist, can someone point me to them? If not, we should develop some so we
>>>> can proceed with the improvements.
>>>>
>>>
>>>    _______________________________________________
>>> Openstack-docs mailing list
>>> Openstack-docs at lists.openstack.org
>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>>
>>>
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20140525/7ec61349/attachment.html>