[Kde-pim] Akonadi design questions

[Volker Krause]

On Thursday 07 June 2007 23:50:48 Christian Schaarschmidt wrote:
> Am Mittwoch, 6. Juni 2007 23:54 schrieb Christian Schaarschmidt:
> > Am Freitag, 1. Juni 2007 08:55 schrieb Volker Krause:
> > > On Wednesday 30 May 2007 23:52:10 Christian Schaarschmidt wrote:
> > > > I have put toghether yet another overview for akonadi I had planed to
> > > > attach. Unfortunately umbrello will no longer display the diagram and
> > > > the .png is to big as attachment. Does anyone have an idea how I
> > > > could convince umbrello to display it again?
> >
> > well, this took longer than expected. I switched to argouml and the first
> > thing that happend was that my archive got corrupted, at least this was
> > fixable... anyway I've attached the result. It might not be 100% UML, but
> > shows the big picture. If you think this could be interesting for others
> > I can upload it.

Most excellent work! That's the best Akonadi design diagram I've seen so 
far :) I definitely want to have that in our docs.

> > The question is where?
> > I'm not sure if is better to start something in
> > http://techbase.kde.org/Projects/kdepim/(akonadi?) or to upload it to the
> > doc directory?

So far we have most of the docs done by doxygen, which has the advantage of 
being close to the code and providing automatic linking, etc..

> > techbase could be used to list q&a, todos from this thread, links to
> > related projects, etc.

There is also pim.kde.org/akonadi, but techbase might actually a better place 
for stuff like eg. a todo list or a list of (junior) jobs. I have been 
thinking about adding a central PIM JJ page since that concept seems to have 
been quite successful recently, but that's a different topic.

> I did some more doc reading. most of the documentation is available in doxy
> files, so techbase might not be such a good idea after all ... ;-)
> what about these ideas?
> - use bug.kde.org for todos, to seperate from real bugs we could use
> special component or target release. always up to date, you can assign/take
>  the todo and close it with svn-commit

interessting idea, I don't have any particullar preferrence here. But I agree 
we need one maintained Akonadi todo list somewhere. With more and more people 
getting interested in helping this would certainly help.

> - some doc houskeeping
> -- remove building block from first page and link from "akonadi design" to
> details
> -- clean up svn (btw, is there a job that generates the dox and copy to
> EBN?)

api.kde.org (which is the same as EBN) rebuilds the docs daily

> http://www.englishbreakfastnetwork.org/apidocs/apidox-kde-4.0/kdepim-apidoc
>s/akonadi/html/index.html based on
>       http://websvn.kde.org/trunk/KDE/kdepim/akonadi/Mainpage.dox
>       (link missing to )
> http://websvn.kde.org/trunk/KDE/kdepim/akonadi/doc/pics/*

the broken image links need probably some fixing in the doxygen script, I have 
that already on my todo list since quite some time

> http://websvn.kde.org/trunk/KDE/kdepim/akonadi/libakonadi/Mainpage.dox
> http://websvn.kde.org/trunk/KDE/kdepim/akonadi/server/Mainpage.dox
>
> http://websvn.kde.org/trunk/KDE/kdepim/akonadi/server/src/storage/Database.
>dox (empty)http://websvn.kde.org/trunk/KDE/kdepim/akonadi/kabc/Mainpage.dox
> (empty)http://websvn.kde.org/trunk/KDE/kdepim/akonadi/kmime/Mainpage.dox
>
> (empty)http://websvn.kde.org/trunk/KDE/kdepim/akonadi/clients/Mainpage.dox

the empty Mainpage.dox files are there because they trigger the API docs 
generation.

> http://websvn.kde.org/trunk/KDE/kdepim/akonadi/doc/Concepts.txt
>   general ideas
>   integrate it into Mainpage.dox ?
>
> http://websvn.kde.org/trunk/KDE/kdepim/akonadi/doc/libakonadi.xmi
>   libakonadi class diagram
>   move to libakonadi/doc?
>   show .png in libakonadi/Mainpage.dox?
>
> http://websvn.kde.org/trunk/KDE/kdepim/akonadi/TODO
>   integrate it into Mainpage.dox ?
>   use bug.kde.org for todos?
>
> http://websvn.kde.org/trunk/KDE/kdepim/akonadi/server/control/README
>   redundant information, see class documentation in header-file
>   remove?
>
> http://websvn.kde.org/trunk/KDE/kdepim/akonadi/server/src/storage/README
>   move to Database.dox ?

that all makes sense, feel free to change that stuff.

Thanks a lot for your work, it happens not very often there is someone 
voluntarily helps with the docs ;-)

regards
Volker
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/kde-pim/attachments/20070609/ec467906/attachment.sig>
-------------- next part --------------
_______________________________________________
kde-pim mailing list
kde-pim at kde.org
https://mail.kde.org/mailman/listinfo/kde-pim
kde-pim home page at http://pim.kde.org/