Hi Daniel I've now done the discussed changes and it is on its way to trunk: https://code.launchpad.net/~hingo/drizzle/7.1-docs-reviewfixes
The 2 points copied below I did nothing about. henrik On Tue, Nov 8, 2011 at 12:30 AM, Henrik Ingo <[email protected]> wrote: > There is one thing that is easiest if you fix, I've reordered so it is > here on top, and then there's a question second. Other than that, I > can take the rest of the email and commit changes - enjoy your > studies! > >>> docs/dirhtml/plugins/query_log/index.html >>> - "Log queries that cause more than N errors." Errors or warnings? >> >> I don't know. :-) I'll have to look at the source code to remind myself >> which session member function it's calling to get this value. >> > > Please do, it's your code so it's easiest for you. > >>> docs/dirhtml/configuration/index.html >>> - This will require some work, but we should script something that creates a >>> page with a table of all options and variables, their types and default >>> and >>> allowed values. (Similar in spirit to >>> http://dev.mysql.com/doc/refman/5.5/en/mysqld-option-tables.html) >>> This is very Google friendly. >> >> I have such a script. It's what I used to generate the 70+ docs for each >> plugin at first. But it's far from perfect because the plugins' code varies >> widely, so it's really difficult to export such a list. I also wanted a >> table, too, like MySQL docu has, but RST tables are poor imho because >> they're really wide. This can be solved with some RST magic in conf.py I >> imagine. Or maybe there's a way in RST to reduce the font size for certain >> text? >> > > At least it could be a good start. Is that script perhaps shared in > launchpad? ;-) > > Ultimately, perhaps the bzr repo could include a script that a plugin > developer would run like: > > 1) ../generate_options_documentation.sh > docs/options.list.rst > 2) manually edit docs/options.list.rst > 3) at build time all plugin/*/docs/options.list.rst are combined > together into a big list at > docs/configuration/list_of_drizzle_options.rst > > Just as a rough idea. Anyway, I think it is reasonable to require that > each plugin developer maintains this list under their docs/ directory. > Possibly this could be the same list of options that is used also in > the plugin docs/index.rst so that index.rst will include > options.list.rst. Then we wouldn't add any documentation burden but it > could still be easily included also into a common big list. > > *** henrik -- [email protected] +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 : [email protected] Unsubscribe : https://launchpad.net/~drizzle-discuss More help : https://help.launchpad.net/ListHelp
