I like that idea. I've put together a list of some stuff that came to my mind where we could still use some documentation or short articles, other snippets or code. This is by no means complete and maybe offtrack, but hey. Once we have a solid amount of good content, it will be easier to use and understand dm, easier to communicate that, and in general very awesome :) If anyone feels like something of this makes sense, feel free to go ahead and *just do it* :)
Oh and btw, when I talk about alfred, I mean http://alfred.datamapper.org and its code at http://github.com/snusnu/alfred More information on features * An awesome community :) * Properly documented API (public, semipublic, private) * Proper specsuite (~some_incredibly_high_number of specs) * Supports multiple storage engines (~30 different adapters) * Simple API to write adapters for different kinds of storage engines * Nice plugin infrastructure (~65 plugins for all kinds of stuff) * Intuitive User API that most of the times just does what you expect * Support for handling multiple repositories (in different storage engines) * Legacy schema support (CPK, precise property mappings) * Native integrity constraints on adapters that support it * Advanced query generation and syntax (SEL, lazy loading, joins) * Reflection API, relationships and properties can be inspected easily * Identity map (with planned moneta support on the roadmap) * DataMapper.auto_migrate!/auto_upgrade! * Support for most major Ruby versions * Proper code documentation (YARD) * CI server checking common ruby versions * Issue Tracker More information on weaknesses * Make current limitations more accessible (self referential m:m, multilevel SEL) * Reporting * OR support More information on architecture * The underlying pattern and where to find it's ideas in dm-core * Walk through frequently used codepaths * Maybe compare it with activerecord where that makes sense * Maybe even something like Michael Klishin's merb internals handbook Collect documentation * Collect interesting discussions (mainly as a starting point for more elaborate articles) - alfred can handle that already * Collect interesting and idiomatic code - alfred can handle that already * Provide an easy way to discover open issues - alfred could probably handle that too * Describe guidelines and best practices for speccing model behavior * Collect domain models for common situations - Along with proper specs, this could be really useful I think - This could be a good way to show off more advanced relationship definitions and other idioms * Collect ways to establish a connection to (multiple) repositories for different backends - It should be easily discoverable how to connect to *any* adapter * Promote the use of standalone snippets to show bugs, or otherwise weird behavior - Maybe let dm-gen allow something like "gen adapter scriptname" * Compare datamapper with activerecord - Architecture - Differences in API * Does it make sense to have a docs branch (like docrails) that would help improve yarddocs? Present documentation (or, ideas for making alfred the "default" dm community site) * Allow to post/ask/reply/vote directly on the website * Provide support and styles for longer articles * Make it so that you ask a question on the website and it will ask that same question in different communication channels (irc, twitter, jabber, whatever) * Use the alfred codebase as source of examples for providing useful snippets (yeah i know, the code would need to be refactored before that :) - I somehow like the idea of showing off dm features within a site that is coded with dm. A site that describes itself and thus (parts) of the tools it was built with. We could maybe come up with cool ideas how to do that, and a cool site is always good for a cool project. Also, I gotta admit that I like coding more than writing articles :) I don't know if at this point it's really necessary to agree over how to exactly contribute snippets of documentation or feature descriptions. All I can say is that alfred already knows how to format markdown :-) cheers snusnu On Wed, Sep 30, 2009 at 00:00, Brian Smith <[email protected]> wrote: > > So today in irc we we're discussing starting an evangelism team, > similar to what rails has. I just wanted to post this up here so we > could start organizing some stuff and see who wants to get involved. > So far the big things we've talked about accomplishing are: > > * writing guides for getting started, tips and tricks, etc > * finding compelling reasons for people to give dm a shot > * screencasts? > > Just wanted to post this to the list and see what people thought? > > > --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "DataMapper" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/datamapper?hl=en -~----------~----~----~----~------~----~------~--~---
