Mailing-List: contact dev-help@flink.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@flink.apache.org
Content-type: text/plain; charset=us-ascii
MIME-version: 1.0 (Mac OS X Mail 8.2 \(2098\))
Subject: Re: How do we want to maintain our documentation?
From: Chiwan Park <chiwanpark@icloud.com>
In-reply-to: 
 <CAGcS-9kfjzw8uJp__tAuACHhVvd2qcmMqsHL90+pLCRj=j2k1w@mail.gmail.com>
Date: Thu, 04 Jun 2015 00:25:54 +0900
Content-transfer-encoding: quoted-printable
Message-id: <A96F729E-CF5E-41E6-A9AB-8776BAA1C019@icloud.com>
References: 
 <CAGr9p8AV7CEfg+y88=5qR1eorzmFXekOv=SnBL=TP_wHoe=eOw@mail.gmail.com>
 <CAGcS-9kfjzw8uJp__tAuACHhVvd2qcmMqsHL90+pLCRj=j2k1w@mail.gmail.com>
To: dev@flink.apache.org

+1 Good. PR should contain documentation.

Regards,
Chiwan Park

> On Jun 4, 2015, at 12:24 AM, Lokesh Rajaram <rajaram.lokesh@gmail.com> =
wrote:
>=20
> +1. I like this idea, not sure if my vote counts :)
>=20
> On Wed, Jun 3, 2015 at 8:21 AM, Robert Metzger <rmetzger@apache.org> =
wrote:
>=20
>> Hi,
>>=20
>> as part of making our codebase ready for the upcoming 0.9 release, =
I've
>> started to go over the documentation of Flink.
>>=20
>> It seems that our current approach for documenting stuff:
>> - We implement and merge a feature
>> - We open a JIRA for documenting it.
>>=20
>> Before the release, we realize that we have many open documentation =
issues
>> (currently 26) and hope that somebody (in this case me) is fixing =
them.
>>=20
>> Some of the pull requests also contain documentation, but certainly =
not all
>> of them.
>>=20
>>=20
>> I am proposing to:
>> - add a rule to our coding guidelines [1] which states that every =
change
>> that affects the documentation needs to update the documentation
>> accordingly.
>> - Committers have to make sure that pull request are following the =
rule
>> before accepting the change. Otherwise, we reject the pull request.
>>=20
>>=20
>> [1] http://flink.apache.org/coding-guidelines.html
>>=20