Re: [Discuss] Rename README.txt to README.md

2017-08-23 Thread Michael Han 
Thanks Pat for the thorough research! I just merged this change in.

On Wed, Aug 23, 2017 at 7:41 AM, Patrick Hunt  wrote:

> I think it's fine to call attention to items on the ML. Not everyone is
> monitoring every jira/pullrequest.
>
> I did some research on Apache pages around releases and while I see the
> README mentioned it doesn't say anything about the particular format
> requirements.
>
> This page in particular mentions the README:
> http://www.apache.org/dev/release-distribution.html#public-distribution
>
> The release policy page makes no mention of the readme:
> http://www.apache.org/legal/release-policy.html
> nor this: http://www.apache.org/dev/release-publishing.html#goal
>
> I also checked LEGAL jira and didn't notice anything there. afaict it
> should be fine to drive through the patch process.
>
> Patrick
>
> On Tue, Aug 22, 2017 at 1:09 PM, Michael Han  wrote:
>
> > Hi Patrick,
> >
> > It's pretty common to start a thread on dev list to discuss none trivial
> > changes - e.g. new features, infrastructure, releases, etc; or changes
> that
> > may lead to inconsistent practices with Apache projects. For this
> specific
> > case, it's the latter case that leads me starting this thread - If Apache
> > enforces using README.txt then we should VOTE for such a change if we
> > decide to do so - though that seems not necessary now and we can conclude
> > in this thread that the proposed rename change is OK.
> >
> > Also, a dev list thread usually will get more visibility than a JIRA, so
> if
> > one has a patch that's need attention, dev list is a good place to start
> > the discussion.
> >
> >
> > On Tue, Aug 22, 2017 at 10:48 AM, Patrick White  wrote:
> >
> > > This seems pretty reasonable.
> > >
> > > ...Which leads me to a question: Is it common to discuss these kinds of
> > > changes on this list as opposed to just submitting a PR/JIRA and
> debating
> > > the change's merits there?
> > > 
> > > From: Michael Han 
> > > Sent: Monday, August 21, 2017 7:32:26 PM
> > > To: dev@zookeeper.apache.org
> > > Subject: [Discuss] Rename README.txt to README.md
> > >
> > > Hi folks,
> > >
> > > I propose we rename README.txt to README.md (ZOOKEEPER-2880
> > > <https://urldefense.proofpoint.com/v2/url?u=https-
> > > 3A__issues.apache.org_jira_browse_ZOOKEEPER-2D2880&d=DwIBaQ&c=
> > > 5VD0RTtNlTh3ycd41b3MUw&r=V07zLXy_E8PWbo7ELpwwaA&m=
> > > rMAKNQByNx5ZgOKc1c0EWzOJi9ueGgFj1CiEDWpPg8o&s=
> > > GpDQr2jQObgdUuS4nt9NNXcKWmAK_dtAeRkVdTR3oEc&e= >), so github can
> > > render the mark downs which support better and richer formatting
> options
> > > than txt file. There are lots of existing Apache projects (e.g. Spark,
> > > Cassandra, ) use md file instead of txt file for README, and I am
> not
> > > aware of any constraints that prevent us doing the same for ZooKeeper.
> > >
> > > Please let me know if you have any concern for such a change.
> > >
> > > --
> > > Cheers
> > > Michael.
> > >
> >
> >
> >
> > --
> > Cheers
> > Michael.
> >
>



-- 
Cheers
Michael.

Re: [Discuss] Rename README.txt to README.md

2017-08-23 Thread Patrick Hunt 
I think it's fine to call attention to items on the ML. Not everyone is
monitoring every jira/pullrequest.

I did some research on Apache pages around releases and while I see the
README mentioned it doesn't say anything about the particular format
requirements.

This page in particular mentions the README:
http://www.apache.org/dev/release-distribution.html#public-distribution

The release policy page makes no mention of the readme:
http://www.apache.org/legal/release-policy.html
nor this: http://www.apache.org/dev/release-publishing.html#goal

I also checked LEGAL jira and didn't notice anything there. afaict it
should be fine to drive through the patch process.

Patrick

On Tue, Aug 22, 2017 at 1:09 PM, Michael Han  wrote:

> Hi Patrick,
>
> It's pretty common to start a thread on dev list to discuss none trivial
> changes - e.g. new features, infrastructure, releases, etc; or changes that
> may lead to inconsistent practices with Apache projects. For this specific
> case, it's the latter case that leads me starting this thread - If Apache
> enforces using README.txt then we should VOTE for such a change if we
> decide to do so - though that seems not necessary now and we can conclude
> in this thread that the proposed rename change is OK.
>
> Also, a dev list thread usually will get more visibility than a JIRA, so if
> one has a patch that's need attention, dev list is a good place to start
> the discussion.
>
>
> On Tue, Aug 22, 2017 at 10:48 AM, Patrick White  wrote:
>
> > This seems pretty reasonable.
> >
> > ...Which leads me to a question: Is it common to discuss these kinds of
> > changes on this list as opposed to just submitting a PR/JIRA and debating
> > the change's merits there?
> > ____
> > From: Michael Han 
> > Sent: Monday, August 21, 2017 7:32:26 PM
> > To: dev@zookeeper.apache.org
> > Subject: [Discuss] Rename README.txt to README.md
> >
> > Hi folks,
> >
> > I propose we rename README.txt to README.md (ZOOKEEPER-2880
> > <https://urldefense.proofpoint.com/v2/url?u=https-
> > 3A__issues.apache.org_jira_browse_ZOOKEEPER-2D2880&d=DwIBaQ&c=
> > 5VD0RTtNlTh3ycd41b3MUw&r=V07zLXy_E8PWbo7ELpwwaA&m=
> > rMAKNQByNx5ZgOKc1c0EWzOJi9ueGgFj1CiEDWpPg8o&s=
> > GpDQr2jQObgdUuS4nt9NNXcKWmAK_dtAeRkVdTR3oEc&e= >), so github can
> > render the mark downs which support better and richer formatting options
> > than txt file. There are lots of existing Apache projects (e.g. Spark,
> > Cassandra, ) use md file instead of txt file for README, and I am not
> > aware of any constraints that prevent us doing the same for ZooKeeper.
> >
> > Please let me know if you have any concern for such a change.
> >
> > --
> > Cheers
> > Michael.
> >
>
>
>
> --
> Cheers
> Michael.
>

Re: [Discuss] Rename README.txt to README.md

2017-08-22 Thread Michael Han 
Hi Patrick,

It's pretty common to start a thread on dev list to discuss none trivial
changes - e.g. new features, infrastructure, releases, etc; or changes that
may lead to inconsistent practices with Apache projects. For this specific
case, it's the latter case that leads me starting this thread - If Apache
enforces using README.txt then we should VOTE for such a change if we
decide to do so - though that seems not necessary now and we can conclude
in this thread that the proposed rename change is OK.

Also, a dev list thread usually will get more visibility than a JIRA, so if
one has a patch that's need attention, dev list is a good place to start
the discussion.


On Tue, Aug 22, 2017 at 10:48 AM, Patrick White  wrote:

> This seems pretty reasonable.
>
> ...Which leads me to a question: Is it common to discuss these kinds of
> changes on this list as opposed to just submitting a PR/JIRA and debating
> the change's merits there?
> 
> From: Michael Han 
> Sent: Monday, August 21, 2017 7:32:26 PM
> To: dev@zookeeper.apache.org
> Subject: [Discuss] Rename README.txt to README.md
>
> Hi folks,
>
> I propose we rename README.txt to README.md (ZOOKEEPER-2880
> <https://urldefense.proofpoint.com/v2/url?u=https-
> 3A__issues.apache.org_jira_browse_ZOOKEEPER-2D2880&d=DwIBaQ&c=
> 5VD0RTtNlTh3ycd41b3MUw&r=V07zLXy_E8PWbo7ELpwwaA&m=
> rMAKNQByNx5ZgOKc1c0EWzOJi9ueGgFj1CiEDWpPg8o&s=
> GpDQr2jQObgdUuS4nt9NNXcKWmAK_dtAeRkVdTR3oEc&e= >), so github can
> render the mark downs which support better and richer formatting options
> than txt file. There are lots of existing Apache projects (e.g. Spark,
> Cassandra, ) use md file instead of txt file for README, and I am not
> aware of any constraints that prevent us doing the same for ZooKeeper.
>
> Please let me know if you have any concern for such a change.
>
> --
> Cheers
> Michael.
>



-- 
Cheers
Michael.

Re: [Discuss] Rename README.txt to README.md

2017-08-22 Thread Patrick White 
This seems pretty reasonable.

...Which leads me to a question: Is it common to discuss these kinds of changes 
on this list as opposed to just submitting a PR/JIRA and debating the change's 
merits there?

From: Michael Han 
Sent: Monday, August 21, 2017 7:32:26 PM
To: dev@zookeeper.apache.org
Subject: [Discuss] Rename README.txt to README.md

Hi folks,

I propose we rename README.txt to README.md (ZOOKEEPER-2880
<https://urldefense.proofpoint.com/v2/url?u=https-3A__issues.apache.org_jira_browse_ZOOKEEPER-2D2880&d=DwIBaQ&c=5VD0RTtNlTh3ycd41b3MUw&r=V07zLXy_E8PWbo7ELpwwaA&m=rMAKNQByNx5ZgOKc1c0EWzOJi9ueGgFj1CiEDWpPg8o&s=GpDQr2jQObgdUuS4nt9NNXcKWmAK_dtAeRkVdTR3oEc&e=
 >), so github can
render the mark downs which support better and richer formatting options
than txt file. There are lots of existing Apache projects (e.g. Spark,
Cassandra, ) use md file instead of txt file for README, and I am not
aware of any constraints that prevent us doing the same for ZooKeeper.

Please let me know if you have any concern for such a change.

--
Cheers
Michael.

[Discuss] Rename README.txt to README.md

2017-08-21 Thread Michael Han 
Hi folks,

I propose we rename README.txt to README.md (ZOOKEEPER-2880
), so github can
render the mark downs which support better and richer formatting options
than txt file. There are lots of existing Apache projects (e.g. Spark,
Cassandra, ) use md file instead of txt file for README, and I am not
aware of any constraints that prevent us doing the same for ZooKeeper.

Please let me know if you have any concern for such a change.

-- 
Cheers
Michael.