The MySQL documentation looks pretty good to me. I think that figuring out to use docbook or not is a bit ahread of the game at this point, I could be wrong. I think what is most important is that documentation starts to be written. I like the way MySQL documentation is laid out - but I think we could improve upon their layout by keeping things a bit simpler.
My concept is to split the documentation into 3 sections: - Developer (provided that the SQL syntax is different from MySQL - System Administrator for those simply using Drizzle - Architectural Design - Drizzle is used for high-performance, highly distributed architectures (from what I have read at least). In my opinion, I think we need architectural design docs that document and account using Drizzle in practice and including use cases and design best practices. I like the idea of contributing to the Wiki, but what can we offer in terms of a downloadable pdf that isn't in the Wiki? Why would we use one and not the other, because many projects offer both. >On my own blog, I've got a few of these and if you'd like, you may want to >scrape them and update them for non-Linux platforms. That would be a great >task to tackle. >Here are the links to my articles: >http://jpipes.com/index.php?/archives/248-Getting-a-Working-CC++-Development-Environment-for-Developing-Drizzle.html I like this doc and think its a good starting point for Drizzle. I'd like to get some feedback from the current users to get a general idea of what IDE's they are using and what works/doesn't work out there. >http://jpipes.com/index.php?/archives/249-A-Contributors-Guide-to-Launchpad.net-Part-1-Getting-Started.html Good starting point. What was the goal of this article for, getting started with using drizzle, or developing with it? I am beginning to integrate this information into a general document. How should I go about submitting the document for peer review? Does launchpad have a specific feature for this, or should I just kick it around the lists? Maybe I can just post it online and use webnotes (http://www.webnotes.net/) for people to mark it up. I have begun working on the system administration / using Drizzle / setting up your IDE (expanding on Jay's docs) first, because this is my area of expertise. Thanks for any and all feedback. Matthew ------------------------------------------------------------ Re: [Drizzle-discuss] Documentation * To: cronos4d <ntw...@xxxxxxxxx> * Subject: Re: [Drizzle-discuss] Documentation * From: Jay Pipes <jay.pi...@xxxxxxx> * Date: Wed, 03 Dec 2008 09:28:34 -0500 * Cc: Drizzle Discuss <drizzle-disc...@xxxxxxxxxxxxxxxxxxx> * In-reply-to: <20081203052113.8995.33796.launch...@xxxxxxxxxxxxxxxxxxxxxxx> * List-archive: <http://lists.launchpad.net/drizzle-discuss> * List-help: <https://help.launchpad.net/ListHelp> * List-id: <drizzle-discuss.lists.launchpad.net> * List-owner: <https://launchpad.net/~drizzle-discuss> * List-post: <mailto:[email protected]> * List-subscribe: <https://launchpad.net/~drizzle-discuss> * List-unsubscribe: <https://launchpad.net/~drizzle-discuss> * References: <20081203052113.8995.33796.launch...@xxxxxxxxxxxxxxxxxxxxxxx> * Sender: jay.pi...@xxxxxxx * User-agent: Thunderbird 2.0.0.18 (X11/20081125) cronos4d wrote: Hello, I am a technical writer and I was wondering if you would like me to contribute to the documentation for the drizzle project? Hi! Thanks very much for your offer! Of course, we'd be delighted to receive any contributions in the docs area. Right now, it's quite early in the development process, but certainly in the next few months we should have some ideas on how to tackle documentation (e.g. do we use a version of the MySQL docbook stuff, or something else?) Keep following this mailing list and we'll let you know when the time is right :) For immediate stuff, the Drizzle wiki on drizzle.org is a good place to put rough documentation, especially any tutorials for new contributors. It would be great to get some articles on setting up development environemnts, running tests, etc. On my own blog, I've got a few of these and if you'd like, you may want to scrape them and update them for non-Linux platforms. That would be a great task to tackle. Here are the links to my articles: http://jpipes.com/index.php?/archives/248-Getting-a-Working-CC++-Development-Environment-for-Developing-Drizzle.html http://jpipes.com/index.php?/archives/249-A-Contributors-Guide-to-Launchpad.net-Part-1-Getting-Started.html http://jpipes.com/index.php?/archives/250-A-Contributors-Guide-to-Launchpad.net-Part-2-Code-Management.html _______________________________________________ Mailing list: https://launchpad.net/~drizzle-discuss Post to : [email protected] Unsubscribe : https://launchpad.net/~drizzle-discuss More help : https://help.launchpad.net/ListHelp
