[Koha-devel] Notices and slips documentation RFC

[Barton Chittenden]

I see your point about eliminating duplication of effort... somewhat less
so about failing QA for lack of documentation... undocumented features
become a support issue, and that falls in my lap ;-).

--Barton

On Mon, Nov 19, 2018 at 10:30 AM Renvoize, Martin <
martin.renvoize at ptfs-europe.com> wrote:

> I agree with Katrin here, I have been slowly working manual submissions
> into my QA workflow with requests for patch authors to submit a
> corresponding manual submission at the same time as the Bugzilla entry.
>
> Documenting notices feels like it fits in nicely with that.. rather than
> requiring double work (POD + Manual) we should be requiring just one place
> be updated.
>
> I'd have no issues with adding a specific coding guideline for this sort
> of thing however.. right now I just encourage corresponding manual merge
> requests but I can't really Fail QA on a patch that doesn't have one.
>
> *Martin Renvoize*
>
> <https://www.ptfs-europe.com>
>
> Development Team Manager
>
>
>
>
>
> *Phone:* +44 (0) 1483 378728
>
> *Mobile:* +44 (0) 7725 985 636
>
> *Email:* martin.renvoize at ptfs-europe.com
>
> *Fax:* +44 (0) 800 756 6384
>
>
> www.ptfs-europe.com
>
>
>
>
>
>
>
> Registered in the United Kingdom No. 06416372   VAT Reg No. 925 7211 30
>
> The information contained in this email message may be privileged,
> confidential and protected from disclosure. If you are not the intended
> recipient, any dissemination, distribution or copying is strictly
> prohibited. If you think that you have received this email message in
> error, please email the sender at info at ptfs-europe.com
>
>
>
> On Mon, 19 Nov 2018 at 15:22, Katrin Fischer <Katrin.Fischer.83 at web.de>
> wrote:
>
>> Hi,
>>
>> I feel if we want one source of truth besides the source code, it would
>> make sense to submit patches to the manual directly instead of adding more
>> documentation outside of it. Adding a POD file will need another person to
>> work on adding it to the manual regularly. Let's not make things more
>> complicated!
>>
>> Katrin
>>
>> *Gesendet:* Montag, 19. November 2018 um 16:15 Uhr
>> *Von:* "Barton Chittenden" <barton at bywatersolutions.com>
>> *An:* sophie.meynieux at biblibre.com
>> *Cc:* Koha-devel <koha-devel at lists.koha-community.org>
>> *Betreff:* Re: [Koha-devel] Notices and slips documentation RFC
>> The field guide is based on the wiki page, which I maintained... but I
>> think that developers should be documenting any notices they add, which is
>> why I've added this to the agenda for Wednesday's dev meeting:
>>
>> *Review of coding guidelines*
>>
>>    - Proposed coding guideline DOC2: Entries in the *letter* table must
>>    be documented in *Koha/Notices.pod*. See Bug 21858 - RFC: Notices and
>>    slips documentation
>>    <https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=21858>
>>
>>
>> On Mon, Nov 19, 2018 at 8:55 AM Sophie Meynieux <
>> sophie.meynieux at biblibre.com> wrote:
>>
>>> Thanks,
>>> It's ok with the url but you can't find it (or I can't find it) directly
>>> on 18.05 documentation page
>>>
>>> Sophie
>>>
>>> --
>>> Responsable support
>>> BibLibre
>>> + 33 (0)4 91 81 35 08
>>> http://www.biblibre.com
>>>
>>> Le 19/11/2018 à 14:44, Michael Kuhn a écrit :
>>> > Hi Sophie
>>> >
>>> > > Until 17.11, there was a Field Guide for Notices and slips in Koha
>>> > > documentation
>>> > >
>>> > (
>>> https://koha-community.org/manual/17.11/en/html/17_miscellaneous.html#field-guide-for-notices-slips
>>> )
>>> >
>>> > > but it seems to have desappeared in 18.05
>>> >
>>> > For Koha 18.05 you can find the field guide at
>>> >
>>> >
>>> https://koha-community.org/manual/18.05/en/html/17_miscellaneous.html#field-guide-for-notices-slips
>>> >
>>> >
>>> > Best wishes: Michael
>>> _______________________________________________
>>> Koha-devel mailing list
>>> Koha-devel at lists.koha-community.org
>>> http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
>>> website : http://www.koha-community.org/
>>> git : http://git.koha-community.org/
>>> bugs : http://bugs.koha-community.org/
>>
>> _______________________________________________ Koha-devel mailing list
>> Koha-devel at lists.koha-community.org
>> http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
>> website : http://www.koha-community.org/ git :
>> http://git.koha-community.org/ bugs : http://bugs.koha-community.org/
>> _______________________________________________
>> Koha-devel mailing list
>> Koha-devel at lists.koha-community.org
>> http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
>> website : http://www.koha-community.org/
>> git : http://git.koha-community.org/
>> bugs : http://bugs.koha-community.org/
>
> _______________________________________________
> Koha-devel mailing list
> Koha-devel at lists.koha-community.org
> http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-devel
> website : http://www.koha-community.org/
> git : http://git.koha-community.org/
> bugs : http://bugs.koha-community.org/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.koha-community.org/pipermail/koha-devel/attachments/20181119/9b76cf68/attachment.html>