openstack-doc-core team mailing list archive

[Anne Gentle <anne@xxxxxxxxxxxxx>]

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
>
>

Attachment: Analytics_docs.openstack.org_20120423-20120429_(Weekly_Google_analytics_report).pdf
Description: Adobe PDF document