[maemo-developers] Proposed reorganization of documentation bug reporting

[From: Jarmo.Tikka at nokia.com]

Hi,

> -----Original Message-----
> From: ext Andre Klapper [mailto:aklapper at openismus.com]
> Sent: 22 April, 2010 15:54
> To: maemo-developers at maemo.org; Tikka Jarmo (Nokia-D/Helsinki);
> dneary at maemo.org
> Subject: RE: Proposed reorganization of documentation bug reporting
> 
> Am Dienstag, den 20.04.2010, 07:37 +0200 schrieb Jarmo.Tikka at nokia.com:
> > Any progress on this maemo.org Bugzilla reorganization for
> > documentation bugs?
> 
> I'm still a bit reluctant as I would like to see latest comments and
> concerns answered first.
> Andrew Flegg commented on the current separation and workflows are not
> totally clear yet (as per Dave Neary's questions), but if everybody
> says
> "Go ahead!" I can do the reorganization in maemo.org Bugzilla later
> this week.

I thought that I had answered all open questions related to this proposal. The discussion in this mailing list has been minimal so I have not noticed any new questions.

Do you (or somebody else) have any specific questions/concerns in your mind? 

> 
> (One more comment below this quote, please scroll down.)

Actually below is one concern so I try to answer it :).

> 
> > > > 1. Create a top classification named Documentation listed at
> > https://bugs.maemo.org/enter_bug.cgi
> > > >
> > > > 2. Create the following products/subcomponents:
> > > * Device User Guides & Help
> > >   * documents delivered together with device or device sales box
> > > * Developer Guides
> > >   * maemo.org wiki http://wiki.maemo.org/Documentation/
> > >   * reviewed version in Maemo Info Center
> > >     http://library.maemodocs.nokia.com/
> > > * Tutorials
> > >   * maemo.org wiki http://wiki.maemo.org/Documentation/
> > >   * reviewed versions in Maemo Info Center
> > >      http://library.maemodocs.nokia.com/
> > > * API Documents
> > >   * from sources delivered from maemo.org SDK repositories
> > >     http://repository.maemo.org/
> > >   * reviewed versions in Maemo Info Center
> > >     http://library.maemodocs.nokia.com/
> > > * Example Applications
> > >   * from MaemoExamples Garage project
> > >     http://vcs.maemo.org/svn/maemoexamples/tags/
> > >
> > > > Bugs reported against Documentation->API docs should be moved to
> the
> > > > product they're being reported against with the "docs" keyword as
> we
> > > do
> > > > now - this will make two potential places to record API bugs, but
> I
> > > > think this is OK.
> 
> So "API Documents" is just a placeholder and should have a component
> "Please avoid filing reports here. File them against the specific
> product/component and add the "docs" keyword instead." ?

API documents are somewhat problematic because:

1. if problems they need to be fixed to the source code and regenerated (only Nokia and team responsible of that specific component can fix this unless somebody wants to take upstream approach and wait until doc fix from upstream gets to the Maemo).

2. it has proven to be difficult for people to map from API document to the actual technology component in Maemo.org Bugzilla mainly because we do not have all technology components defined in Bugzilla :)

These are the reasons I propose generic API document component to the Bugzilla that somebody who knows into what technology component possible bug reports must be moved or can even create new components to the Bugzilla.

If somebody knows for what component API doc bugs should be created (and that component exists in Bugzilla :) that is the preferred way to file these bugs.

Cheers,
//Jarmo 

> 
> 
> andre
> --
> Andre Klapper (maemo.org bugmaster)