A complete summary of doc.keliglia.com status

Hi all :) First, I'd like to thank Gabor again for keeping this fight for the website. It seems like it's not a sleeping project no more! You're a great man! :) Merci Derick too for his reactivity. ATM, there's a party in my house and I was obliged to disconnect my girlfriend laptop to go write my mails in the kitchen :)) Thunderbird also crashed so I don't have any mail in front of me ATM, forgive me if I forget some topics. There was a lot of emails exchanged on the list (and offlist), I'm unable to answer them all (the house is crowded and I have to come back to the party soon), so I'm trying to group everything here.. 1 - The server: --------------- Guillaume Plessis is supposed to install the server as soon as he can. He will do it on his spare time, and knowing him well, I know that he's always busy with his official work. He was on holiday lately and we didn't want to make him work again. In short, the official server will be online one (sweet) day. While waiting for this, Yannick (and Guillaume) is providing us his personal server without any restriction (only for sudo access, sure). Topic closed (?) :) 2 - The unofficial website: --------------------------- Yannick (mostly), Guillaume (admin) and I have been developping a first draft since last week. The url is : http://doc.keliglia.com/ This website is still messy (a lot of french comments, redundancy, etc) and I was planing to clean it out before making it public. (Vincent, I'll kick you from #phpdoc as soon as I get back online :p) What was done so far ? * templates : they are derived from the official websites. Seems like we're not going to use them, but Yannick have made a lot of efforts to make them XHTML 1.0 strict compliant. Maybe the official sites can use them so that we won't be wasting any effort ? :) * revcheck : I rewrote everything from scratch to integrate an sqlite database to handle it. The idea is : - a single database per documentation (pear, smarty, ..) - the ability to build the database for several languages at once. Why did I use sqlite instead of simply generating static HTML pages ? There are a lot of reasons : * when we first started to use this system on phpdoc-fr, the generated

    page was really huge, and made my browser crash several times. (now
    we're 99% uptodate, so this is not a probelm anymore for the french translation :))

* I wanted to be able to dynamically extract the outdated files for a

    particular translator, without having to run revcheck.php for every dude.
    My idea is to have a login system for every @php.net member, to be able
    to provide a karma system over the website (who is able to edit the news ?
    who can drop the comments ?) Sqlite was a clear answer to me.

It seems like Gabor wasn't to happy with sqlite, what about it now, with the explanations ? Yannick used jpgraph to provide some graphic for revcheck. We can compare the different translation status with a single look to a picture, or we can see the detailed status of a translation with another one. I'm one of those who believe that the revcheck system should be applied and compulsary for every translation in every documentation. It was a really pain in the ass to help Damien on phpdoc-fr because I didn't have any way to make sure that a particular XML file was up to date without reading the english and french one in parralel. PHP is a serious project, its documentation deserves a serious management too. Also, I'm an optimistic guy, I believe that if someone reads a translation of the manual, and sees a warning claiming that this translation is outdated. This someone can help us updating the translation if we provide a simple way to do it. (see the phpdoc/RFC for the findings about a visual editing utility) * RFC: From my experience, when an RFC (Request For Comments) is published, the only way to provide comments is to answer with an mail. Some comments get lost in the archives.. Sometimes the RFC slowly dies without bringing anything. I've sent an RFCs for this website 6 or 7 months ago, for the user notes system a year ago.. nothing was done until today, and I'm not sure to be able to provide all the comments that I've collected since then. I asked Yannick to make a simple RFC reader/comment system on the website. It's a basic stuff, and it's online, waiting for your comments. Maybe we can create an RFC dir in each documentation repository to discuss the particular topics (restructuring the install part for phpdoc, using phpdocumentor for peardoc, ..), and an RFC dir in the website CVS module to discuss some global issues (how do we document a class ? I know Steph has been waiting for an official and global answer since ... too much time). We could also drop a fresh XML DTD for the RFCs, to add more informations, something like : <rfc id="xx"> <title>title</title> <topic>short description</topic> <content> <para>

    plop plop plop

</para> </content> </rfc> (or whatever structure you want) We will extract the various commit messages to provide a summary of changes. Anyway, waiting for comments on this (it's an RFC :D). * Splitted the site ------------------- Actually we have : The unified site : http://doc.keliglia.com/ A per documentation site : http://pear.doc.keliglia.com/ for example The idea behind this is *not* to separate the efforts at all. We're all in the mood of sharing our knowledge (pear know well how to document OO Api), our new stuff (livedocs)... The idea is to be able quickly to access a documentation specific information. For example, I'm Mr Foo, and I'm only interested in gtk docs. I don't want to read all php, pear, smarty stuff when I'm seeking an information on the website. SO I just have to prepend "gtk." to the general URL to see GTK informations. We did this with a vhost system, but sure, we can do it via folders, or whatever you'd like to. For now, we're sharing the same files and filtering the rendered HTML if a documentation type is provided. http://doc.keliglia.com/ is our meeting point, it's the place where we'll group our efforts, but every language has its particular things, don't forget it :) This is all what I see for the moment, I've got to go back to the party or I'll sleep on the sofa tonight ;) I'll have a look at my mails tomorrow morning and will try to be more reactive. Oh, forgot something important. I've been credited with a lot of things for doc.keliglia.com, but it's mostly Yannick's work. Rendons à Cesar ce qui appartient à Cesar :) Regards, Mehdi Achour