[Proposal] Keel docs and example app
"Shash Chatterjee" <[email protected]>
| Newsgroups | gmane.comp.java.keel.user |
|---|---|
| Message-ID | <[email protected]> |
All, In response to the frequent complaint against Keel about docs and examples, and in response to Ashish's comments yesterday, I was thinking how best to approach the problem. I am certain there is no way the current set of contributors can accomplish much more, given that they already spend a large chunk of time contributing to Keel. I think that we can setup a framework for documentation and ongoing development of an example app. that will be worked on by the user community. To that end, I was thinking of setting up a SourceForge project called keel-app, where CVS access would be available simply for asking. Based on feedback here, we can define the outline of what a useful document would look like, as well as define a simple but real app. that we would develop as a team on the user-list. This is not unlike the Wiki in that anybody would be able to contribute to the doc., but different in that the structure would not be so free-flowing as the Wiki. I don't think those of us familiar with Keel should be suggesting what the doc. should look like (we did that already on the Wiki, it makes perfect sense to us, but looks like users don't find it that easy to navigate). So here's the feedback I am looking for from the community: - Should we setup a keel-app project on SF? - What should be the outline of the document(s)? (I'll collate all the feedback, and come up with a superset which we can then pair-down). - What should the example-app do? (Please don't ask for your next real project here :-), I think it should show some real persistents, define its own interchangeable services, use multiple DBs, have multiple UIs (Struts, Cocoon,Webwork2, JSF). It has to be more real than app-hoj, of course. Note that we already have exaple apps (app-register, app-poll, etc.) in CVS, but I am suggesting that we start from scratch that will tie in closely with the text in the doc. - The most important piece: who is willing to volunteer and chip-in on the doc or the app? Shash