I also realized there's been no discpline in documenting plugins. Once I finish my current explorations into JSON and JavaScript, I hope to join you in this work.
In fact, I recently proposed for merging updates to the README: https://code.launchpad.net/~hingo/drizzle/drizzle-README-update This is related to my own experiences in compiling drizzle, plus a person I helped out on IRC. henrik On Sun, Sep 4, 2011 at 5:13 PM, pcrews <glee...@gmail.com> wrote: > You kick butt, sir! : ) > It's more than a good start, it is a *great* foundation and I salute you for > doing the work on this. > Many, many thanks! > > On 09/03/2011 06:28 PM, Daniel Nichter wrote: >> >> I have completed documenting every Drizzle plugin: >> https://code.launchpad.net/~daniel-nichter/drizzle/plugin-docs >> I proposed it for merging. The plugin docs still need a lot of work, but >> this is a good start. >> >> Le 13 août 2011 à 15:16, Daniel Nichter a écrit : >> >>> I just pushed >>> https://code.launchpad.net/~daniel-nichter/drizzle/plugin-docs. I'm working >>> on documenting all of Drizzle's plugins. I wrote a program that >>> auto-generated .rst skeletons for each plugin by parsing the .cc files, and >>> now I'm going through and fleshing out those skeletons. All plugins in that >>> branch have at least skeleton docu, and the first half of the plugins (up to >>> http_functions) have more complete, corrected documentation (because the >>> auto-generated skeletons aren't perfect, but they saved me a lot of work). >>> >>> So, if someone wants to checkout that branch and build the html and look >>> at the first half of the plugins' documentation and provide feedback, that >>> would be excellent. The docu currently breaks "make html", but that's >>> because it's not finished yet. And there's other little inaccuracies that >>> will be fixed later. >>> >>> What's important at this stage is: do you like the general layout and >>> contents? As you'll see, the plugin docs follow a pretty standard format. >>> The addition of a Variables section is new and important, imho, because >>> people want to know about a plugin's variables as much as its command line >>> options. Also, there are many plugins that don't have any variables, or >>> have variables that aren't connected to command line options and vice versa, >>> etc. I also added a Changelog section because in the long run tracking >>> changes to plugins will be very important. >>> >>> If there are no major objections, I'll continue and hopefully soon we'll >>> have a lot more plugin documentation than ever before. The current stuff >>> may not be perfect, but it's a lot better than no documentation at all. >>> >>> -Daniel >> >> _______________________________________________ >> Mailing list: https://launchpad.net/~drizzle-discuss >> Post to : drizzle-discuss@lists.launchpad.net >> Unsubscribe : https://launchpad.net/~drizzle-discuss >> More help : https://help.launchpad.net/ListHelp > > > _______________________________________________ > Mailing list: https://launchpad.net/~drizzle-discuss > Post to : drizzle-discuss@lists.launchpad.net > Unsubscribe : https://launchpad.net/~drizzle-discuss > More help : https://help.launchpad.net/ListHelp > -- henrik.i...@avoinelama.fi +358-40-8211286 skype: henrik.ingo irc: hingo www.openlife.cc My LinkedIn profile: http://www.linkedin.com/profile/view?id=9522559 _______________________________________________ Mailing list: https://launchpad.net/~drizzle-discuss Post to : drizzle-discuss@lists.launchpad.net Unsubscribe : https://launchpad.net/~drizzle-discuss More help : https://help.launchpad.net/ListHelp
