[OpenStack-docs] Criteria for next RST migration

Andreas Jaeger aj at suse.com
Tue Mar 31 05:58:49 UTC 2015


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,

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, Jennifer Guild, Dilip Upmanyu,
        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