[OpenStack-docs] Criteria for next RST migration

Nick Chase nchase at mirantis.com
Tue Apr 7 13:16:35 UTC 2015


On Tuesday, March 31, 2015, Tom Fifield <tom at openstack.org> wrote:
> On 31/03/15 13:58, Andreas Jaeger wrote:
>> On 03/31/2015 03:32 AM, Anne Gentle wrote:
>>> Hi all,
>>>
>>> Thinking on what the criteria for the next guide to go to RST, I wanted
>>> us to consider these data points. I mentioned this need in the last doc
>>> team meeting.
>>>
>>> Our goal is to have a sense of not only "what's next" but also the
>>> ability to answer why a guide is next, especially if (since) we're
>>> crunched for time and resources.
>>>
>>> 1. Number of readers based on web analytics from Google Analytics, such
>>> as unique page views per time period.
>>> 2. Number of contributors in the last two releases (one calendar year of
>>> data) from Stackalytics or git.
>>> 3. Ease of migration - size of guide or simplicity of guide.
>>> 4. Automation efforts - what amount of the guide is auto-generated and
>>> does that make it easier to migrate what remains (or possibly more
>>> difficult).
>>>
>>> Any other criteria you can think of, just write back to the list so we
>>> can discuss further. I'm sure I haven't thought of everything so bring
>>> your data ideas.
>>
>> 5. Conditionals - a guide without any conditionals is easier. Getting
>> the User Guides separated was non-trivial,
>>
>> Btw. let's do it slowly, we can convert one guide after the other and
>> still have some questions to answer like how to handle the glossary,
>>
>
> 6. Translation & Internationalisation - current status & ease of migration

7. Is the guide being rewritten withmostly new content anyway. (Seems silly
to write in docbook just to have to convert it later.)

---- Nick


> http://lists.omailman/lisdocs
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150407/f8510d60/attachment.html>


More information about the OpenStack-docs mailing list