openstack-doc-core team mailing list archive

[Anne Gentle <anne@xxxxxxxxxxxxx>]

Ok, that makes perfect sense to me.

I'll do a first pass. Here are some things that stick out of me from the
last five months of analytics.

- The Starter Guide for Diablo still gets a huge number of hits. It's also
a popular landing page That guide will be updated for Essex this week. I
expect a similar trend.

- The Compute Admin guide (trunk or diablo) is the next most popular
landing page. I think people are returning to it, and they usually read
10-12 page per visit.

- The Object Storage Admin guide has the highest bounce rate pages in it.
The ring causes confusion, object replication has high bounce, it's also
possible that they think Object Storage is actually block storage, which
it's not. There are doc bugs logged against this guide so it's not
surprising but a good second set of info.

- The new reference listing of all 467 nova config options is sporting a
74% bounce rate. My guess is that it doesn't offer enough information
really about configuration, but someone searched for the option name and
only found that page. Since there are still 4-5 doc bugs remaining about
how to configure nova, this is also not surprising. From that page visitors
try other pages about configuring specific parts of Compute, like the API,
so I think work spent there would be well spent.

- To your credit Razique, the new multi-nic page is doing very well in the
stats. Lots of visitors, less than 50% bounce rate. I think it would get a
"kick-ass" section rating!

I do realize a high bounce rate might be a good thing, that people find
what they need and move on. I'm looking for topics where I don't think
they're finding what they need.

VNC and volumes are both highly visited topics.

I'm surprised the networking topics aren't more visited. Perhaps they're
not as findable? Seems like people are always asking about it on the list.

Here are the top 25 search terms on docs.openstack.org (the top search
field):

  keystone  quantum  dashboard  swift  nova  architecture  diablo  essex
vmware  api  nova configuration  nova-manage restart all services  install
Quantum  snapshot  vnc  installation  network  kvm  live migration
nova-manage  nova.conf  scheduler  ubuntu  windows
I hope this is helpful and close to what you were originally seeking. We
can revisit in 3 months and see how trends are looking.
Thanks,
Anne


On Sun, May 6, 2012 at 7:05 PM, Lorin Hochstein <lorin@xxxxxxxxxxxxxxxxxx>wrote:

> Hi Anne:
>
> It's good to know the analytics data is there if we want to dig
> deeper. However, until somebody working on docs starts asking specific
> analytics-driven questions about the site usage, it's probably not worth
> setting up an automatic report emailed to the team. At least, I know I
> wouldn't spend much time looking at the report...
>
>  Take care,
>
> Lorin
> --
> Lorin Hochstein
> Lead Architect - Cloud Services
> Nimbis Services, Inc.
> www.nimbisservices.com
>
>
>
> On May 4, 2012, at 10:00 AM, Anne Gentle wrote:
>
> Hi all -
> Not a silly idea at all. We've had a request to the doc tools team for a
> while to get "ratings" on pages - annotations would be another great step.
> How to take action... so we did make the Cloud doc tool plugin open source
> before the summit. The first priority to me is to get anchor tags on
> api.openstack.org, and I've asked Matt Stephenson to take that on. Can we
> find another Java programmer who would like to work on a user story like
> one of these:
> As a reader of the OpenStack documentation, I'd like to quickly log a bug
> against a page that's out-dated.
> As a reader of the OpenStack documentation, I'd like to make a quick vote
> on how effective the page is.
>
> Joe Savak, can you put these request into the tracking system you want to
> use for the Cloud docs plugin? It can be openstack-manuals if you want.
>
> As for analytics, I've attached the weekly report. We've been collecting
> data since the site started and I find it informative but of course you
> have to interpret. I could set up the report to be emailed to this list
> weekly. What do you think? I can also do customized reports for particular
> pages or sections (volumes, networking, and so on).
>
> Thanks,
> Anne
>
> On Thu, May 3, 2012 at 1:32 PM, Lorin Hochstein <lorin@xxxxxxxxxxxxxxxxxx>wrote:
>
>> On May 3, 2012, at 10:15 AM, Razique Mahroua wrote:
>>
>> Hey there,
>> just had that silly idea :
>> is it possible to rank/ note some part of the documentations ?
>> The logic here is to gather from readers what are the pages they often
>> read, and how much accurate they are . That would help to update the doc
>> bugs importance, and also know for the docs what the readers are expecting
>> from it :
>> - incomplete sections
>> - false directions
>> - outdated examples
>> - kick-ass section
>> etc...
>>
>> Maybe I'm just rambling, possible
>>
>>
>> I'd love a lightweight mechanism for annotating the documentation, where
>> I can do something equivalent to taking a red pen, circling some text, and
>> writing a comment in the margin.
>>
>> Also, As I recall from the summit, we also discussed collecting Google
>> Analytics data on the HTML documentation hosted on docs.openstack.org(?).
>> (I can't remember the outcome of that, though).
>>
>> Take care,
>>
>> Lorin
>> --
>> Lorin Hochstein
>> Lead Architect - Cloud Services
>> Nimbis Services, Inc.
>> www.nimbisservices.com
>>
>>
>>
>>
>>
>>
>> --
>> Mailing list: https://launchpad.net/~openstack-doc-core
>> Post to     : openstack-doc-core@xxxxxxxxxxxxxxxxxxx
>> Unsubscribe : https://launchpad.net/~openstack-doc-core
>> More help   : https://help.launchpad.net/ListHelp
>>
>>
>
> <Analytics_docs.openstack.org_20120423-20120429_(Weekly_Google_analytics_report).pdf>
>
>
>