Drizzle Team, I didn't include a table of contents because there simply aren't enough contents yet. We can add this in later once the "meat" is there. Please have a look. http://drizzle.org/wiki/User_Documentation
Matthew On Mon, Dec 22, 2008 at 4:56 PM, Stewart Smith <[email protected]> wrote: > On Sun, Dec 21, 2008 at 09:13:15PM -0800, Matthew Sacks wrote: >> 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. > > We also have to keep in mind that the MySQL docs are not under a free > license - so we cannot copy&paste at all (and we should be careful about > that). > >> 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. > > how much DBA and sysadmin is split could prove interesting to get > right... but hey, that's why we have a Wiki - it's editable :) > > A "Hacking on Drizzle" section could be good as well... could be quite > brief (as things change all the time) but with enough pointers to get > people going. > > >> 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'd just put it up, post to list and then people can look/edit/add to > discuss page (or inline to the doc). > > > -- > Stewart Smith > _______________________________________________ Mailing list: https://launchpad.net/~drizzle-discuss Post to : [email protected] Unsubscribe : https://launchpad.net/~drizzle-discuss More help : https://help.launchpad.net/ListHelp
