source: project/wiki/Hackathon1 @ 9470

Last change on this file since 9470 was 9470, checked in by sjamaan, 12 years ago

Mark 'mole' as mine

File size: 14.5 KB
Line 
1== The first Chicken Hackathon!
2
3The first chicken hackathon will be held in the weekend of 23-24 February, on IRC in #chicken on irc.freenode.net
4
5Here are some suggestions on what to do.  During the hackathon, please mark something with your name to indicate you want to work on it, so no unnecessary duplicate work gets done.
6
7*  Update existing documentation
8  - Please do not touch the documentation of any of the eggs maintained by [[ivan raikov|me]]. It is already annoying enough to deal with eggs that have documentation on the wiki but not in their directory in the SVN tree. -Ivan
9   
10* Document core Chicken stuff (needs to be broken up into more specific chunks, core committers, please indicate what's not documented yet)
11
12* Improve pre/post egg commit hooks
13** RSS feed(s)
14** general cleaning and refactoring
15
16* Improve the Chicken performance on [[http://shootout.alioth.debian.org/|The Computer Language Benchmarks Game]]
17
18=== Documentation on wiki, docs in eggs
19
20Ivan raises a good point. The wiki is fine, but to have no documentation in the egg itself is a pain.
21
22Perhaps for eggs that have local documentation, we could write something to copy the current local docs into the wiki (with a preamble, warning that the wiki docs may be overridden). A 'comments' section at the bottom of the wiki page could be preserved across updates from the local docs.
23
24The trick is that there are multiple local-doc formats: eggdoc, HTML file, etc. It may be a tough or intractable problem if we don't reduce the number of variations. However, documentation preferences are hard to unify, so [[Mark Fredrickson]] proposed the following guidelines and priorities to avoid a [[http://en.wikipedia.org/wiki/Color_of_the_bikeshed|bikeshed]]:
25
26# Our primary focus is on updating documentation where it currently resides (wiki, svn, etc) in the format it currently uses. Getting the documentation that exists current is a big task as it is. Let's not worry about moving documentation just yet.
27# Where documentation is non-existent, give the person(s) working on the new documentation the right to choose the format.
28# Let's put any new functionality on the back burner, at least when talking about the Hackathon. -)
29# Let's try to dedicate some time to infrastructure improvements: Mario suggested expanding SVN wiki tags, it sounds like the *-commit hooks could use a refactoring, etc. As Zbigniew said, infrastructure lasts.
30
31=== Non-wiki-doc'ed eggs
32
33This is a quick list resulting from a script Graham Fawcett made  This list may not be complete, but it's a starting point. Please concentrate on the oldskool HTML docs first. eggdoc documentation should probably be converted semi-automatically once the new wiki syntax is here. Please put your name here if you start working on one of these, to prevent duplicate work.
34
35Ozzi added more eggs to the list.
36
37<table>
38<tr>
39<th>Egg</th>
40<th>Current Docs</th>
41<th>Converted By</th>
42</tr>
43<tr>
44<td>PS-tk</td>
45<td>HTML</td>
46<td>[[Peter Bex]]</td>
47</tr>
48<tr>
49<td>SSAX-Project</td>
50<td>eggdoc</td>
51<td></td>
52</tr>
53<tr>
54<td>alexpander</td>
55<td>eggdoc</td>
56<td></td>
57</tr>
58<tr>
59<td>apr</td>
60<td>None</td>
61<td>To be documented by the authors</td>
62</tr>
63<tr>
64<td>array-lib</td>
65<td>eggdoc</td>
66<td></td>
67</tr>
68<tr>
69<td>asxt</td>
70<td>HTML</td>
71<td>[[Peter Bex]]</td>
72</tr>
73<tr>
74<td>atlas-lapack</td>
75<td>eggdoc</td>
76<td></td>
77</tr>
78<tr>
79<td>autoload</td>
80<td>HTML</td>
81<td>[[Peter Bex]]</td>
82</tr>
83<tr>
84<td>awk</td>
85<td>HTML</td>
86<td>[[Peter Bex]]</td>
87</tr>
88<tr>
89<td>base64</td>
90<td>HTML</td>
91<td>[[Zbigniew]] (some time ago, not during hackathon)</td>
92</tr>
93<tr>
94<td>bb</td>
95<td>HTML</td>
96<td>[[Peter Bex]]</td>
97</tr>
98<tr>
99<td>binary-parse</td>
100<td>HTML</td>
101<td>[[Peter Bex]]</td>
102</tr>
103<tr>
104<td>blas</td>
105<td>eggdoc</td>
106<td></td>
107</tr>
108<tr>
109<td>bloom-filter</td>
110<td>eggdoc</td>
111<td></td>
112</tr>
113<tr>
114<td>c3</td>
115<td>HTML</td>
116<td>[[Peter Bex]]</td>
117</tr>
118<tr>
119<td>cgi-util</td>
120<td>eggdoc</td>
121<td></td>
122</tr>
123<tr>
124<td>charconv</td>
125<td>HTML</td>
126<td>[[Peter Bex]]</td>
127</tr>
128<tr>
129<td>coerce</td>
130<td>HTML</td>
131<td>[[Peter Bex]]</td>
132</tr>
133<tr>
134<td>complex</td>
135<td>HTML</td>
136<td>[[Peter Bex]]</td>
137</tr>
138<tr>
139<td>crypt</td>
140<td>HTML</td>
141<td>[[Peter Bex]]</td>
142</tr>
143<tr>
144<td>crypt3</td>
145<td>HTML</td>
146<td>[[Peter Bex]]</td>
147</tr>
148<tr>
149<td>csv</td>
150<td>HTML</td>
151<td>[[Peter Bex]]</td>
152</tr>
153<tr>
154<td>curl</td>
155<td>eggdoc</td>
156<td></td>
157</tr>
158<tr>
159<td>datatype</td>
160<td>HTML</td>
161<td>[[Peter Bex]]</td>
162</tr>
163<tr>
164<td>defstruct</td>
165<td>HTML</td>
166<td>[[Peter Bex]]</td>
167</tr>
168<tr>
169<td>digraph</td>
170<td>eggdoc</td>
171<td></td>
172</tr>
173<tr>
174<td>dissector</td>
175<td>HTML</td>
176<td>[[Peter Bex]]</td>
177</tr>
178<tr>
179<td>dyn-vector</td>
180<td>eggdoc</td>
181<td></td>
182</tr>
183<tr>
184<td>endian-port</td>
185<td>eggdoc</td>
186<td></td>
187</tr>
188<tr>
189<td>environments</td>
190<td>HTML</td>
191<td>[[Peter Bex]]</td>
192</tr>
193<tr>
194<td>etxtproc</td>
195<td>eggdoc</td>
196<td></td>
197</tr>
198<tr>
199<td>expat</td>
200<td>HTML</td>
201<td>[[Peter Bex]]</td>
202</tr>
203<tr>
204<td>extended-cond</td>
205<td>eggdoc</td>
206<td></td>
207</tr>
208<tr>
209<td>ezxdisp</td>
210<td>HTML</td>
211<td>[[Peter Bex]]</td>
212</tr>
213<tr>
214<td>fmt</td>
215<td>TeX2page?</td>
216<td>We'll leave this to the author ([[Alex Shinn]])</td>
217</tr>
218<tr>
219<td>format-graph</td>
220<td>eggdoc</td>
221<td></td>
222</tr>
223<tr>
224<td>format-textdiff</td>
225<td>eggdoc</td>
226<td></td>
227</tr>
228<tr>
229<td>ftl</td>
230<td>HTML</td>
231<td>Already wikified?</td>
232</tr>
233<tr>
234<td>ftp</td>
235<td>HTML</td>
236<td>[[Peter Bex]]</td>
237</tr>
238<tr>
239<td>g2</td>
240<td>HTML</td>
241<td>[[Peter Bex]]</td>
242</tr>
243<tr>
244<td>gdb</td>
245<td>eggdoc</td>
246<td></td>
247</tr>
248<tr>
249<td>gdbm</td>
250<td>HTML</td>
251<td>[[Peter Bex]]</td>
252</tr>
253<tr>
254<td>generalised-case</td>
255<td>HTML</td>
256<td>[[Peter Bex]]</td>
257</tr>
258<tr>
259<td>glfw (NO DOCUMENTATION AT ALL)</td>
260<td></td>
261<td></td>
262</tr>
263<tr>
264<td>glut</td>
265<td>HTML</td>
266<td>[[Peter Bex]]</td>
267</tr>
268<tr>
269<td>gmp</td>
270<td>HTML</td>
271<td>[[Peter Bex]]</td>
272</tr>
273<tr>
274<td>graph-bfs</td>
275<td>eggdoc</td>
276<td></td>
277</tr>
278<tr>
279<td>graph-cycles</td>
280<td>eggdoc</td>
281<td></td>
282</tr>
283<tr>
284<td>graph-dfs</td>
285<td>eggdoc</td>
286<td></td>
287</tr>
288<tr>
289<td>graph-scc</td>
290<td>eggdoc</td>
291<td></td>
292</tr>
293<tr>
294<td>gtk2</td>
295<td>eggdoc</td>
296<td></td>
297</tr>
298<tr>
299<td>gtk2-glade</td>
300<td>eggdoc</td>
301<td></td>
302</tr>
303<tr>
304<td>gtk2-gobject</td>
305<td>eggdoc</td>
306<td></td>
307</tr>
308<tr>
309<td>hashes</td>
310<td>eggdoc</td>
311<td></td>
312</tr>
313<tr>
314<td>html-plots</td>
315<td>eggdoc</td>
316<td></td>
317</tr>
318<tr>
319<td>inline</td>
320<td>HTML</td>
321<td>[[Peter Bex]]</td>
322</tr>
323<tr>
324<td>input-parse</td>
325<td>eggdoc</td>
326<td></td>
327</tr>
328<tr>
329<td>interp1d</td>
330<td>eggdoc</td>
331<td></td>
332</tr>
333<tr>
334<td>irc</td>
335<td>HTML</td>
336<td>[[Peter Bex]]</td>
337</tr>
338<tr>
339<td>irnc-base</td>
340<td>eggdoc</td>
341<td></td>
342</tr>
343<tr>
344<td>iset</td>
345<td>HTML</td>
346<td>[[Peter Bex]]</td>
347</tr>
348<tr>
349<td>iup (NO DOCUMENTATION AT ALL)</td>
350<td></td>
351<td></td>
352</tr>
353<tr>
354<td>japi</td>
355<td>HTML</td>
356<td>[[Peter Bex]]</td>
357</tr>
358<tr>
359<td>lalr</td>
360<td>eggdoc</td>
361<td></td>
362</tr>
363<tr>
364<td>lazy-ffi</td>
365<td>HTML</td>
366<td>[[Peter Bex]]</td>
367</tr>
368<tr>
369<td>libsvm</td>
370<td>eggdoc</td>
371<td></td>
372</tr>
373<tr>
374<td>lightning</td>
375<td>HTML</td>
376<td>[[Peter Bex]]</td>
377</tr>
378<tr>
379<td>lookup-table</td>
380<td>eggdoc</td>
381<td></td>
382</tr>
383<tr>
384<td>loop</td>
385<td>HTML</td>
386<td>[Peter Bex]</td>
387</tr>
388<tr>
389<td>mailbox</td>
390<td>HTML</td>
391<td>[Peter Bex]</td>
392</tr>
393<tr>
394<td>make</td>
395<td>HTML</td>
396<td>[[Peter Bex]]</td>
397</tr>
398<tr>
399<td>mapm</td>
400<td>HTML</td>
401<td>[[Peter Bex]]</td>
402</tr>
403<tr>
404<td>mat5-lib</td>
405<td>eggdoc</td>
406<td></td>
407</tr>
408<tr>
409<td>matcher</td>
410<td>HTML</td>
411<td>[[Peter Bex]]</td>
412</tr>
413<tr>
414<td>matrix-utils</td>
415<td>eggdoc</td>
416<td></td>
417</tr>
418<tr>
419<td>mayo</td>
420<td>eggdoc</td>
421<td></td>
422</tr>
423<tr>
424<td>meroon</td>
425<td>Already wikified</td>
426<td></td>
427</tr>
428<tr>
429<td>metakit</td>
430<td>Generated HTML - "Generated by Docutils from reStructuredText source"</td>
431<td>Leave this to the authors</td>
432</tr>
433<tr>
434<td>mime</td>
435<td>eggdoc</td>
436<td></td>
437</tr>
438<tr>
439<td>misc-extn</td>
440<td>eggdoc</td>
441<td></td>
442</tr>
443<tr>
444<td>miscmacros</td>
445<td>HTML</td>
446<td>[[Peter Bex]]</td>
447</tr>
448<tr>
449<td>mole</td>
450<td>HTML</td>
451<td>[[Peter Bex]]</td>
452</tr>
453<tr>
454<td>mpd-client</td>
455<td>eggdoc</td>
456<td></td>
457</tr>
458<tr>
459<td>mpi</td>
460<td>eggdoc</td>
461<td></td>
462</tr>
463<tr>
464<td>mysql</td>
465<td>eggdoc</td>
466<td></td>
467</tr>
468<tr>
469<td>ncurses</td>
470<td></td>
471<td></td>
472</tr>
473<tr>
474<td>nordsieck-vector</td>
475<td>eggdoc</td>
476<td></td>
477</tr>
478<tr>
479<td>npdiff</td>
480<td>eggdoc</td>
481<td></td>
482</tr>
483<tr>
484<td>oblist</td>
485<td></td>
486<td></td>
487</tr>
488<tr>
489<td>octave</td>
490<td></td>
491<td></td>
492</tr>
493<tr>
494<td>ode</td>
495<td>eggdoc</td>
496<td></td>
497</tr>
498<tr>
499<td>ode-lmm (NO DOCUMENTATION AT ALL)</td>
500<td></td>
501<td></td>
502</tr>
503<tr>
504<td>opengl</td>
505<td></td>
506<td></td>
507</tr>
508<tr>
509<td>orders</td>
510<td>eggdoc</td>
511<td></td>
512</tr>
513<tr>
514<td>patch</td>
515<td>eggdoc</td>
516<td></td>
517</tr>
518<tr>
519<td>pcap</td>
520<td></td>
521<td></td>
522</tr>
523<tr>
524<td>plist-utils</td>
525<td>eggdoc</td>
526<td></td>
527</tr>
528<tr>
529<td>pmatch</td>
530<td></td>
531<td></td>
532</tr>
533<tr>
534<td>pop3</td>
535<td></td>
536<td></td>
537</tr>
538<tr>
539<td>postgresql</td>
540<td></td>
541<td></td>
542</tr>
543<tr>
544<td>ppi</td>
545<td></td>
546<td></td>
547</tr>
548<tr>
549<td>probdist</td>
550<td>eggdoc</td>
551<td></td>
552</tr>
553<tr>
554<td>protobj</td>
555<td></td>
556<td></td>
557</tr>
558<tr>
559<td>pyffi</td>
560<td>eggdoc</td>
561<td></td>
562</tr>
563<tr>
564<td>qdbm</td>
565<td></td>
566<td></td>
567</tr>
568<tr>
569<td>random-mtzig</td>
570<td>eggdoc</td>
571<td></td>
572</tr>
573<tr>
574<td>random-swb</td>
575<td>eggdoc</td>
576<td></td>
577</tr>
578<tr>
579<td>random-test</td>
580<td>eggdoc</td>
581<td></td>
582</tr>
583<tr>
584<td>rb-tree</td>
585<td>eggdoc</td>
586<td></td>
587</tr>
588<tr>
589<td>regex-case</td>
590<td></td>
591<td></td>
592</tr>
593<tr>
594<td>rfc3339</td>
595<td></td>
596<td></td>
597</tr>
598<tr>
599<td>rgraph</td>
600<td></td>
601<td></td>
602</tr>
603<tr>
604<td>rss</td>
605<td></td>
606<td></td>
607</tr>
608<tr>
609<td>s11n</td>
610<td>eggdoc</td>
611<td></td>
612</tr>
613<tr>
614<td>sandbox</td>
615<td></td>
616<td></td>
617</tr>
618<tr>
619<td>schelog</td>
620<td></td>
621<td></td>
622</tr>
623<tr>
624<td>sdl</td>
625<td></td>
626<td></td>
627</tr>
628<tr>
629<td>sedna</td>
630<td></td>
631<td></td>
632</tr>
633<tr>
634<td>sendfile</td>
635<td>eggdoc</td>
636<td></td>
637</tr>
638<tr>
639<td>sfht</td>
640<td>eggdoc</td>
641<td></td>
642</tr>
643<tr>
644<td>sfio</td>
645<td></td>
646<td></td>
647</tr>
648<tr>
649<td>sigma</td>
650<td>eggdoc</td>
651<td></td>
652</tr>
653<tr>
654<td>silex</td>
655<td></td>
656<td></td>
657</tr>
658<tr>
659<td>simple-macros</td>
660<td></td>
661<td></td>
662</tr>
663<tr>
664<td>slang</td>
665<td>eggdoc</td>
666<td></td>
667</tr>
668<tr>
669<td>smtp</td>
670<td></td>
671<td></td>
672</tr>
673<tr>
674<td>sockets</td>
675<td></td>
676<td></td>
677</tr>
678<tr>
679<td>sparse-vectors</td>
680<td></td>
681<td></td>
682</tr>
683<tr>
684<td>spread</td>
685<td></td>
686<td></td>
687</tr>
688<tr>
689<td>sql</td>
690<td>eggdoc</td>
691<td></td>
692</tr>
693<tr>
694<td>sqlite</td>
695<td></td>
696<td></td>
697</tr>
698<tr>
699<td>sqlite3</td>
700<td>eggdoc</td>
701<td></td>
702</tr>
703<tr>
704<td>sqlite3-tinyclos</td>
705<td>eggdoc</td>
706<td></td>
707</tr>
708<tr>
709<td>srfi-25</td>
710<td></td>
711<td></td>
712</tr>
713<tr>
714<td>srfi-27</td>
715<td>eggdoc</td>
716<td></td>
717</tr>
718<tr>
719<td>srfi-37</td>
720<td></td>
721<td></td>
722</tr>
723<tr>
724<td>srfi-38</td>
725<td>HTML</td>
726<td>gabalz</td>
727</tr>
728<tr>
729<td>srfi-4-utils</td>
730<td>eggdoc</td>
731<td></td>
732</tr>
733<tr>
734<td>srfi-40</td>
735<td></td>
736<td></td>
737</tr>
738<tr>
739<td>srfi-42</td>
740<td></td>
741<td></td>
742</tr>
743<tr>
744<td>srfi-47</td>
745<td></td>
746<td></td>
747</tr>
748<tr>
749<td>srfi-57</td>
750<td></td>
751<td></td>
752</tr>
753<tr>
754<td>srfi-60</td>
755<td></td>
756<td></td>
757</tr>
758<tr>
759<td>ssax</td>
760<td></td>
761<td></td>
762</tr>
763<tr>
764<td>stalin</td>
765<td></td>
766<td></td>
767</tr>
768<tr>
769<td>stream-base64</td>
770<td></td>
771<td></td>
772</tr>
773<tr>
774<td>stream-cgi</td>
775<td></td>
776<td></td>
777</tr>
778<tr>
779<td>stream-flash</td>
780<td></td>
781<td></td>
782</tr>
783<tr>
784<td>stream-flash-tree-map</td>
785<td></td>
786<td></td>
787</tr>
788<tr>
789<td>stream-htpasswd</td>
790<td></td>
791<td></td>
792</tr>
793<tr>
794<td>stream-httplog</td>
795<td></td>
796<td></td>
797</tr>
798<tr>
799<td>stream-ldif</td>
800<td></td>
801<td></td>
802</tr>
803<tr>
804<td>stream-parser</td>
805<td></td>
806<td></td>
807</tr>
808<tr>
809<td>structures</td>
810<td></td>
811<td></td>
812</tr>
813<tr>
814<td>svn-post-commit-hooks</td>
815<td></td>
816<td></td>
817</tr>
818<tr>
819<td>syntax-case</td>
820<td>HTML</td>
821<td>[[alaric-blagrave-snellpym]]</td>
822</tr>
823<tr>
824<td>tagged-begin</td>
825<td>HTML</td>
826<td>[[alaric-blagrave-snellpym]]</td>
827</tr>
828<tr>
829<td>tcc</td>
830<td>HTML</td>
831<td>[[alaric-blagrave-snellpym]]</td>
832</tr>
833<tr>
834<td>tcp-server</td>
835<td>HTML</td>
836<td>[[alaric-blagrave-snellpym]]</td>
837</tr>
838<tr>
839<td>tcp6</td>
840<td>HTML</td>
841<td>[[Peter Bex]]</td>
842</tr>
843<tr>
844<td>test-infrastructure</td>
845<td>HTML</td>
846<td>[[Peter Bex]]</td>
847</tr>
848<tr>
849<td>testbase</td>
850<td>HTML</td>
851<td>[[Peter Bex]]</td>
852</tr>
853<tr>
854<td>tk</td>
855<td>HTML</td>
856<td>[[Peter Bex]]</td>
857</tr>
858<tr>
859<td>treap</td>
860<td>eggdoc</td>
861<td></td>
862</tr>
863<tr>
864<td>udp</td>
865<td>HTML</td>
866<td>[[alaric-blagrave-snellpym]]</td>
867</tr>
868<tr>
869<td>unitconv</td>
870<td>eggdoc</td>
871<td></td>
872</tr>
873<tr>
874<td>unix-sockets</td>
875<td>HTML</td>
876<td></td>
877</tr>
878<tr>
879<td>uri</td>
880<td>HTML</td>
881<td></td>
882</tr>
883<tr>
884<td>url</td>
885<td>HTML</td>
886<td>[[Ozzi Lee]]</td>
887</tr>
888<tr>
889<td>utf8</td>
890<td>HTML</td>
891<td></td>
892</tr>
893<tr>
894<td>xlib</td>
895<td>HTML</td>
896<td>[[Ozzi Lee]]</td>
897</tr>
898<tr>
899<td>xmi</td>
900<td>HTML</td>
901<td>[[Ozzi Lee]]</td>
902</tr>
903<tr>
904<td>xml-rpc</td>
905<td>HTML</td>
906<td>[[Ozzi Lee]]</td>
907</tr>
908<tr>
909<td>xosd</td>
910<td>HTML</td>
911<td>[[Ozzi Lee]]</td>
912</tr>
913<tr>
914<td>yasos</td>
915<td>HTML</td>
916<td>[[Ozzi Lee]]</td>
917</tr>
918</table>
919
920=== Introductions to Chicken
921
922To attract more programmers from other languages, we could create a series of "Chicken for Blub Programmers," where Blub could be PHP, Ruby, Python, SML, whatever. More specifically, here are links to skeleton pages:
923
924* [[Chicken for PHP Programmers]] -- [[Mark Fredrickson]] volunteers for this one (since nothing was done yet, I ([[Jean-Philippe Theberge]]) have started the page)
925* [[Chicken for Ruby Programmers]] -- [[Mark Fredrickson]] also volunteers for this one, as he just said he would do a presentation at his local Ruby group.
926                                                                      [[Raymond Medeiros]] [[Peter Bex]]
927* [[Chicken for Perl Programmers]]
928* [[Chicken for Python Programmers]]
929* [[Chicken for Java Programmers]]
930
931
932=== Egg-post-commit functionality
933
934As mentioned above, the repository needs some cleanup and more post-commit stuff should
935be possible. So [[felix winkelmann|I]] would like to use the hackathon for
936
937* cleaning up the [[egg-post-commit]] scripts and make it easier to add tasks to be executed (for example RSS feeds)
938* move the pre-3.0.0 eggs into their own {{release/2}} branch
939
940[[felix winkelmann]]
941
942=== Finished tasks
943
944Please put your name and a description of what you've finished here, so we can make a summary what was done during the hackathon.
945
946* Finished [[wmiirc]] documentation -- [[Peter Bex]]
947* An initial version of [[Chicken for Python programmers]] -- [[Mario Domenech Goulart]]
948* An initial version of [[chicken-for-ruby-programmers]] -- [[Peter Bex]]
949* Managed to break the wiki -- [[Peter Bex]]
950* Fixed the wiki -- [[Alejandro Forero Cuervo]]
951* Added more examples to [[chicken-for-ruby-programmers]]
952
Note: See TracBrowser for help on using the repository browser.