Re: [Maria-developers] Documentation for new features in MariaDB

2009-09-06 Thread Henrik Ingo
On Fri, Sep 4, 2009 at 10:31 PM, Daniel Bartholomew wrote: > Henrik> For now, we should aim at documenting the new features we > Henrik> produce, both as release notes and as an incomplete reference > Henrik> manual (complete when read as an addon to MySQL manual). > > To facilitate this I have cre

Re: [Maria-developers] Documentation for new features in MariaDB

2009-09-04 Thread Daniel Bartholomew
On Wed, 26 Aug 2009 15:28:49 +0300, Henrik Ingo wrote: Henrik> The knowledgebase will be used Creole markup. I believe Daniel Henrik> already that Mediawiki markup is an ok interim solution. Yes, mediawiki markup is close enough to Creole to be a good interim format. Henrik> It seems to me if

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-26 Thread Henrik Ingo
Note: I strive to post a summary of MariaDB things discussed at MP company meeting last week. Knowing more about the vision for the askmonty.org knowledgebase, I thought picking up this thread is appropriate: On Sun, Aug 16, 2009 at 8:04 PM, Henrik Ingo wrote: > Just to make it clear: Over time w

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-16 Thread Robert Hodges
Hi everyone, We have gone through some of the same wiki vs. real doc thinking on Tungsten that has come up here in the list. Our conclusion was that you need to do documentation properly right from the start. This includes: * Pick one technology and use it consistently. * Ensure you can deal w

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-16 Thread Henrik Ingo
On Fri, Aug 14, 2009 at 10:30 AM, Kristian Nielsen wrote: > Henrik Ingo writes: > >> Now that I think about it, maybe this part of the documentation effort >> could for the time being be done as a diff against the MySQL manual. >> (Which is DocBook?) > > Have you checked the implications of the co

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-14 Thread Kristian Nielsen
Henrik Ingo writes: > Now that I think about it, maybe this part of the documentation effort > could for the time being be done as a diff against the MySQL manual. > (Which is DocBook?) Have you checked the implications of the copyright/license issues for this idea? - Kristian. __

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-14 Thread Bryan Alsdorf
Henrik Ingo wrote: Now that I think about it, maybe this part of the documentation effort could for the time being be done as a diff against the MySQL manual. (Which is DocBook?) According to this, yes docbook. http://dev.mysql.com/doc/mysqldoc-guide/en/mysqldoc-guide-overview.html I guess

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Henrik Ingo
On Thu, Aug 13, 2009 at 10:31 PM, Bryan Alsdorf wrote: > We aren't creating a system for a plain manual, we are creating a knowledge > base so the community can help us generate content and ask questions. This > KB can be used for our manual as well. If we ever want a more formal manual, > we can a

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Bryan Alsdorf
Hi, Oleksandr "Sanja" Byelkin wrote: Daniel Bartholomew пишет: On Thu, 13 Aug 2009 14:44:29 +0300, "Oleksandr \"Sanja\" Byelkin" wrote: Daniel> http://askmonty.org/buildbot/reports/test_markup.php Daniel> It's simple, but it does let you view the creole => html Daniel> translation of your ma

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Morgan Tocker
On Wed, Aug 12, 2009 at 9:27 AM, Kristian Nielsen wrote: > We are starting to add new features to MariaDB (that are not in MySQL), > including user-visible features. > > I think we need to decide now how we will handle keeping documentation for > these new features. > > There is an open issue about

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Oleksandr "Sanja" Byelkin
Daniel Bartholomew пишет: > On Thu, 13 Aug 2009 14:44:29 +0300, "Oleksandr \"Sanja\" Byelkin" > wrote: > > Daniel> http://askmonty.org/buildbot/reports/test_markup.php > > Daniel> It's simple, but it does let you view the creole => html > Daniel> translation of your markup. > > Oleksandr> It

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Daniel Bartholomew
On Thu, 13 Aug 2009 11:17:08 +0300, "Oleksandr \"Sanja\" Byelkin" wrote: Oleksandr> I see one problem with Wiki-like markups - they are not Oleksandr> designed to get result as hard copy (book/brochure) IMHO it Oleksandr> is big disadvantage, some people like to read something Oleksandr> materi

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Daniel Bartholomew
On Thu, 13 Aug 2009 14:44:29 +0300, "Oleksandr \"Sanja\" Byelkin" wrote: Daniel> http://askmonty.org/buildbot/reports/test_markup.php Daniel> It's simple, but it does let you view the creole => html Daniel> translation of your markup. Oleksandr> It do not understand UTF-8 - it is really bad.

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Oleksandr "Sanja" Byelkin
Daniel Bartholomew пишет: > On Thu, 13 Aug 2009 09:15:06 +0200, Kristian Nielsen > wrote: > > > > Kristian> I'm happy to try Creole as Daniel suggested. Though it would > Kristian> be good if there was an easy way to display the result of > Kristian> formatting the text (for the developer writi

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Daniel Bartholomew
On Thu, 13 Aug 2009 10:57:42 +0300, Henrik Ingo wrote: Henrik> If you start writing the docs in a wiki markup, then the natural Henrik> question is, why not use a subsection of AskMonty.org as "the Henrik> repository". You would then have it automatically validated and Henrik> formatted when pr

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Daniel Bartholomew
On Thu, 13 Aug 2009 09:15:06 +0200, Kristian Nielsen wrote: Kristian> I'm happy to try Creole as Daniel suggested. Though it would Kristian> be good if there was an easy way to display the result of Kristian> formatting the text (for the developer writing the Kristian> documentation). Bryan cr

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Kristian Nielsen
Henrik Ingo writes: > If you start writing the docs in a wiki markup, then the natural > question is, why not use a subsection of AskMonty.org as "the > repository". You would then have it automatically validated and Yes. In this case, we need to do more careful work, as then the documentation

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Oleksandr "Sanja" Byelkin
Hi! Henrik Ingo пишет: > On Thu, Aug 13, 2009 at 10:15 AM, Kristian > Nielsen wrote: >> And actually, I see no reason for now to put documentation in a separate >> repository (and several reasons not to). So I suggest to just write new >> documentation in Docs/mariadb.txt. >> >> I'm happy to try C

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Henrik Ingo
On Thu, Aug 13, 2009 at 10:15 AM, Kristian Nielsen wrote: > And actually, I see no reason for now to put documentation in a separate > repository (and several reasons not to). So I suggest to just write new > documentation in Docs/mariadb.txt. > > I'm happy to try Creole as Daniel suggested. Though

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-13 Thread Kristian Nielsen
"Oleksandr \"Sanja\" Byelkin" writes: > If format is simple we can do it as were doing in early MySQL - every > developer adds description to the doc then editor fix what he things is > better. This of course require: Yes, that is what I have in mind as well. And actually, I see no reason for n

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-12 Thread Daniel Bartholomew
On Wed, 12 Aug 2009 15:27:59 +0200, Kristian Nielsen wrote: Kristian> We are starting to add new features to MariaDB (that are not Kristian> in MySQL), including user-visible features. Kristian> Kristian> I think we need to decide now how we will handle keeping Kristian> documentation for these

Re: [Maria-developers] Documentation for new features in MariaDB

2009-08-12 Thread Oleksandr "Sanja" Byelkin
Kristian Nielsen пишет: > We are starting to add new features to MariaDB (that are not in MySQL), > including user-visible features. [skip] > Also, until we get procedures like at MySQL/Sun for a documentation team that > ensures all features and bug fixes get documented, I think it is the > respo

[Maria-developers] Documentation for new features in MariaDB

2009-08-12 Thread Kristian Nielsen
We are starting to add new features to MariaDB (that are not in MySQL), including user-visible features. I think we need to decide now how we will handle keeping documentation for these new features. There is an open issue about the MySQL documentation being non-free, and whether we can do anythi