← Back to team overview

maria-developers team mailing list archive

Re: Documentation for new features

 

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On 23/12/15 00:56, Sergei Golubchik wrote:
> Hi, Ian!
> 
> On Dec 22, Ian Gilfillan wrote:
>> Hi
>> 
>> I quite often find out about a new feature after release, either
>> by looking through the changelog and commits, or because someone
>> points out it's missing from the documentation.
>> 
>> It's time-consuming trying to keep track of every change, and I
>> miss things (especially in non-default plugins etc), so it'd be
>> better if everyone can remember the need for documentation when
>> adding new features/variables or changes in behaviour.
> 
> I doubt it's possible :(
> 
> During the release preparation I can look through the changelog
> and see what needs to be documented.
> 
> Or we can tweak our workflow in Jira somehow to include
> documentation.

This sounds reasonable. Might just hint to developers "oh that's right
I added a variable X" or "its important to note Y in the release notes"


-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQEcBAEBCAAGBQJWiMMvAAoJEMXeEgVQ15xMba4H/1Odo4j0SH/af9log3r/D2HZ
aFDhf0Cr1YFSd+prSJB33BEHghSFgsPvkFz/8bGAdG7yxtHoPK8BjzZdIedMHGi1
DCxsp0qYFk44xAKnz3f8D2fp7ff9nWSL1HzZAncjXLRLpL13VN8/oetIA8N5CPHK
tmZQ0w/TsbWmybS3V2F0cO39LT77cwxIsZ9q8lbbATuojjUrYKXqj+WIP/tXue8H
w2mDpeRUfyoCISiX9DNoyjuw7b8hIqL7smZOb8aYRGQu9Gfm8NCL/uYzll0FxKHU
tXJ61LkBFlB3FdlIDY3V2B9stxJFUxcArUKjIKH1uUBNzynJWCKhQ9fZxXpHhlE=
=Zw5d
-----END PGP SIGNATURE-----


References