Thursday, March 23, 2006

tricking people is easy, but so is not tricking them

so the boys over at the english breakfast conspiracy network have a cool way of aggregating our failings in API documentation. an oh, mea culpa, are we sinners. or at least so i'd heard. see, i'd never actually looked at it. i know, that's horrible. and eventually it ate at my soul (or what's left of it) and i just had to go look. or maybe i was suffering from insomnia that evening. guilt, insomnia ... whatever.

anyways ... here is what i found.

boy, they look like log files. now, maybe this is why i'm not a sys admin (wait, no that's because i generally dislike dealing with the average human being in their daily attempts to stuff up the network as quickly and thoroughly as possible; i prefer writing the applications they enjoy using in their attempts to stuff up the network as quickly and thoroughly as possible), but i have to say i really don't like log files. they take so long to go through and figure things out in. *whinge* *whinge* *whinge*

but you know what gets me going? besides a hot date or good vegan food (or a hot date with good vegan food .. mm.... hot ... vegan .... foood....

...
*drifts off*
...)

ah, where was i? right.. hot vegan food. what also gets me going are graphs that give me good overviews along with the ability to drill down and search and see progress in the components i work on. if the ebn stats were pretty like that, i'd probably be very easily tricked into using it and getting my api docs into order.

but the log files trick me into running away to blog instead. and lord knows i don't need to do more of that.

to ade, with love and squalor, aseigo... *kisses*

p.s. adridg / ade / adriaan de groot does a lot of great things for kde. he takes on a lot of what i'd consider "shit work" but does it with great gusto and an amazingly wicked sense of humour. he also spent several years in calgary at one point in his life (though not at the same time as myself). the canadian kde conspiracy continues!

1 comment:

Frerich said...

I'll take this opporturnity to point out the way which the DocBook Sanitizer on EBN visualises the results of the nightly runs.

The site consists of a few "navigation" (each of which mainly consists of a table showing some 'product' and the number o issues in that 'product') pages and lots'n'lots of "reports" for the individual application.

The page for KDE 3.5 gives you the totals plus the issues within each KDE module. Note that this table can be sorted by clicking on the column headers: in particular, clicking on the "Issues" header will generate a nice "curve" of bars (the length of each corresponds to the relative number of issues), which gives a pretty good idea of whether there are a few really nasty modules or whether it's spread relatively even over them.

Clicking on e.g. kdenetwork shows you the stats for each application - clicking on each application shows you the actual "report", where you can see which checks it did, whether/what failed and (in case something was b0rked) telling you why you should care about what the report says. ;-)

Since all of those pages are generated from the very same PHP Script (which in turn reads all the information from a SQL database), presenting this information in other formats is quite simple to implement. For instance, at the bottom of each page you will find a link to a corresponding RSS feed, which contais the same information as the page you're viewing.

Since those RSS URLs actually refer another PHP script, you can just stick them into your favorite RSS aggregator (*cough*KNewsTicker*cough*) and they will always be up to date.

Okay, enough advertising. :-)