[Openstack-docs] Use of itemized lists in Ops Guide upgrade chapter

Matt Kassawara mkassawara at gmail.com
Thu May 29 01:06:30 UTC 2014


Alright... I'll upload my patch using the existing markup and see what
happens during the review process.


On Wed, May 28, 2014 at 6:59 PM, Anne Gentle <anne at openstack.org> wrote:

> Some of this is a judgement call due to the way it's written in sections
> with a step or two for each section. For the generalized listing of steps,
> those should remain lists.
>
> These sections could possibly be converted to procedures, but I'll try to
> explain why it might not be a good idea for each:
>
>  - Perform a Backup (this is just two steps, First and Next so likely the
> judgement call was not to use procedure)
>  - Update Configuration Files (there are a lot of "if" statements in this,
> I'm not sure how markup goes for optional steps, so likely they decided not
> to mark up with procedure since it's quite general)
>  - Cleaning Up and Final Configuration File Updates (honestly, I can see
> why this also is not a procedure because it's not step-by-step, it's
> generalized guidance)
>
> Really, I think leave it alone, there is probably higher-value work to do
> than changing the markup there. Your testing has been super valuable and is
> the real value for that documentation.
> Anne
>
>
>
>
>
> On Wed, May 28, 2014 at 6:55 PM, Matt Kassawara <mkassawara at gmail.com>wrote:
>
>> Can anyone tell me why the Ops Guide upgrade chapter uses itemized lists?
>> If possible, I would like to use procedures to improve structure and
>> readability.
>>
>> _______________________________________________
>> 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/20140528/16dcd960/attachment.html>


More information about the Openstack-docs mailing list