A wiki could be good but I strongly encourage any such effort to integrate with ocaml.org, and to carefully weigh the pros and cons. Wikis make contributions easier, but you need someone to keep the content organized and do some basic quality control. Also, the structure of the documentation is not very customizable. The question is whether pushing to a git repo (the current contribution method for ocaml.org) is so much harder (given that we're all programmers after all).
Anil Madhavapeddy <anil@recoil.org> writes:Yes, we could use github pages as long as they are searchable, I see no
> On 20 Dec 2012, at 23:31, Benedikt Meurer <benedikt.meurer@googlemail.com> wrote:
>>
>> On Dec 21, 2012, at 0:22 , Anil Madhavapeddy <anil@recoil.org> wrote:
>>
>>> Personally, I've got mixed feelings about wikis from experience with
>>> previous projects, since they get out of date very rapidly indeed. They
>>> do work well if someone's maintaining it, but if that's the case, why
>>> not just push these tips and guides to the existing ocaml.org site?
>>>
>>> I'm happy to run a wiki on the OCL infrastructure, but would strongly
>>> prefer contributions to the ocaml.org Git repo with all this good stuff
>>> instead! If it really turns out we need a swanky wiki, that can be arranged
>>> later...
>>
>> Why not use the wiki provided by Github for the ocaml.org project?
>
> That works too; Thomas has written a Github Markdown to HTML converter in
> COW [1], and is using that to generate the OPAM website from the Github
> wiki (for the documentation that you see on opam.ocamlpro.com).
problem with it. I think the biggest advantage of wiki would be that
everything would be in single place and hyperlinked.
As for protecting the wiki from being up-date emacswiki [1] is always a
great example that it is possible as long as people maintain their
webpages. Also, I feel that ocaml.org pages on github would be a good
entry point.
[1] http://emacswiki.org/
-Wojciech
--
Caml-list mailing list. Subscription management and archives:
https://sympa.inria.fr/sympa/arc/caml-list
Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
Bug reports: http://caml.inria.fr/bin/caml-bugs