New Documentation Bug

[David T.]

> On Jan 30, 2017, at 8:31 PM, Geert Janssens <geert.gnucash at kobaltwit.be> wrote:
> 
> Op maandag 30 januari 2017 10:55:09 CET schreef David T.:
>> Geert, 
>> That is still the case. 
>> David
>> 
>>  On Mon, Jan 30, 2017 at 15:14, Geert Janssens<geert.gnucash at kobaltwit.be> 
> wrote:   Op zondag 29 januari 2017 08:28:39 CET schreef John Ralls:
>>>> On Jan 29, 2017, at 12:42 AM, David T. via gnucash-devel
>>>> <gnucash-devel at gnucash.org> wrote:
>>>> 
>>>> Hi,
>>>> 
>>>> I just submitted a new documentation bug (bug 777893) to add information
>>>> about the SQL back end to the documentation.
>>>> 
>>>> I am aware of the long-standing issues regarding the SQL back end, but
>>>> it
>>>> seems to me that the basic functionality of these back ends has
>>>> stabilized enough that information about them needs to get in to the
>>>> documentation. In short, it is time to get something in the docs, so
>>>> that
>>>> users new and old can get information that is clear and accurate.
>>>> 
>>>> The reason I am sending this message to the devel list is that this
>>>> topic
>>>> will need the perspective and input from as many expert users and
>>>> developers as possible to ensure that the information added for these
>>>> features is clear about both the status of the feature as well as its
>>>> limitations. The documentation needs to be carefully worded so that
>>>> users
>>>> can make informed decisions about the data format they ultimately
>>>> choose.
>>>> 
>>>> So, please look at the bug, reply here, or make suggestions on wording
>>>> as
>>>> you see fit.
>>> 
>>> ISTM what needs to be covered is:
>>> 
>>> 1. Additional dependencies on Linux.
>>> 2. There are no automatic backups Users must arrange to make periodic
>>> snapshots themselves. 3. No simultaneous multi-user access.
>>> 4. Required privs on MySQL/Maria and Postgres.
>>> 5. Users of MySQL/Maria and Postgres are expected to either be competent
>>> DBAs or have a competent DBA available to help them; the GnuCash team
>>> can't
>>> help with DB management issues.
>> 
>> Does the OS X/Quarz version of gnucash ship with full support for all three
>> dbi backends ? Last time I tried (which was ages ago!) only sqlite was
>> available.
>> 
>> Geert
> 
> Ok, that would be worth mentioning in the docs then as well.
> 
> Regards,
> 
> Geert
> 

Geert,

Thanks for the suggestion.

It occurs to me, though, that John’s comments regarding possible repackaging for the Mac make me wonder more generally whether information that is intended to be short term (such as this) really belongs in the documentation. I am reminded of the What’s New section, which was recently removed from the Guide in acknowledgement of the website being a better location for this. Temporary transitory information such as this is a poor fit in the documentation, as it either forces some person to monitor and change the information all the time (which is a challenge), or it ends up being dated and misleading to users.

I do not know what the best solution in this broader situation is; I am open to suggestions. In the meantime, I will see whether I can work out language that both addresses the issue and mitigates the editorial burden.

Cheers,
David