Re: Change solr/lucene Readme file format

[Houston Putman]

Markdown is very standard at this point and I think the barrier to entry is
very small, at least much smaller than asciidoc, which is used for the ref
guide.

+1 on this for me.

On Wed, Jan 22, 2020 at 9:43 AM Doug Turnbull <
dturnb...@opensourceconnections.com> wrote:

> I think this got lost in the holidays. I wanted to bump this contribution,
> as I feel markdown is pretty standard format for readmes that devs are
> expecting these days. (And the files were close to markdown anyway.)
>
> Or if the project doesn't want this contribution, I feel we should at
> least let Pinkesh (with his 1st contribution) that this isn't something the
> project wants, and close the PR
>
> Best!
> -Doug
>
> On Thu, Nov 14, 2019 at 12:51 AM Man with No Name <
> pinkeshsharm...@gmail.com> wrote:
>
>> Hey guys,
>> I have created a PR  on
>> this, please have a look to see if that's helpful.
>>
>> Thanks:
>> Pinkesh Sharma
>>
>> On Sun, Nov 10, 2019 at 11:29 AM Uwe Schindler  wrote:
>>
>>> Hi,
>>>
>>> When building the documentation (ant documentation), all readme files
>>> included in the documentation are parsed as markdown (see flexmark task in
>>> ant) and converted to html. This works well, although not everything is
>>> markdown. If you have a plain readme file it would still parse as valid
>>> markdown and HTML output looks fine, so Erik's problem with markdown isn't
>>> one.
>>>
>>> Uwe
>>>
>>> Am November 10, 2019 4:00:21 PM UTC schrieb Marcus Eagan <
>>> marcusea...@gmail.com>:

 Most README files in contemporary open source projects are Markdown
 because of the formatting features. I personally favor convention over ease
 of use in this case.

 Marcus Eagan

 On Sun, Nov 10, 2019, 8:58 AM Erick Erickson 
 wrote:

> Personally I’d make them text files. The last thing I want to do is
> make reading/updating these have a barrier to entry. We should save
> formatting for the ref guide and/or Wiki.
>
> Best,
> Erick
>
> > On Nov 10, 2019, at 1:01 AM, Man with No Name <
> pinkeshsharm...@gmail.com> wrote:
> >
> > Hey folks,
> > I have been looking into the solr/lucene source code, and the first
> thing caught my eye was the different Readme files. All the files had
> different file and text format. What do you guys think about making all 
> the
> readmes to markdown file rather than text files, and a standard template?
> >
> >
> > --
> > Regards:
> > Pinkesh Sharma
>
>
> -
> To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
> For additional commands, e-mail: dev-h...@lucene.apache.org
>
>
>>> --
>>> Uwe Schindler
>>> Achterdiek 19, 28357 Bremen
>>> https://www.thetaphi.de
>>>
>>
>>
>> --
>> Regards:
>> Pinkesh Sharma
>>
>
>
> --
> *Doug Turnbull **| CTO* | OpenSource Connections
> , LLC | 240.476.9983
> Author: Relevant Search 
> This e-mail and all contents, including attachments, is considered to be
> Company Confidential unless explicitly stated otherwise, regardless
> of whether attachments are marked as such.
>

Re: Change solr/lucene Readme file format

[Doug Turnbull]

I think this got lost in the holidays. I wanted to bump this contribution,
as I feel markdown is pretty standard format for readmes that devs are
expecting these days. (And the files were close to markdown anyway.)

Or if the project doesn't want this contribution, I feel we should at least
let Pinkesh (with his 1st contribution) that this isn't something the
project wants, and close the PR

Best!
-Doug

On Thu, Nov 14, 2019 at 12:51 AM Man with No Name 
wrote:

> Hey guys,
> I have created a PR  on
> this, please have a look to see if that's helpful.
>
> Thanks:
> Pinkesh Sharma
>
> On Sun, Nov 10, 2019 at 11:29 AM Uwe Schindler  wrote:
>
>> Hi,
>>
>> When building the documentation (ant documentation), all readme files
>> included in the documentation are parsed as markdown (see flexmark task in
>> ant) and converted to html. This works well, although not everything is
>> markdown. If you have a plain readme file it would still parse as valid
>> markdown and HTML output looks fine, so Erik's problem with markdown isn't
>> one.
>>
>> Uwe
>>
>> Am November 10, 2019 4:00:21 PM UTC schrieb Marcus Eagan <
>> marcusea...@gmail.com>:
>>>
>>> Most README files in contemporary open source projects are Markdown
>>> because of the formatting features. I personally favor convention over ease
>>> of use in this case.
>>>
>>> Marcus Eagan
>>>
>>> On Sun, Nov 10, 2019, 8:58 AM Erick Erickson 
>>> wrote:
>>>
 Personally I’d make them text files. The last thing I want to do is
 make reading/updating these have a barrier to entry. We should save
 formatting for the ref guide and/or Wiki.

 Best,
 Erick

 > On Nov 10, 2019, at 1:01 AM, Man with No Name <
 pinkeshsharm...@gmail.com> wrote:
 >
 > Hey folks,
 > I have been looking into the solr/lucene source code, and the first
 thing caught my eye was the different Readme files. All the files had
 different file and text format. What do you guys think about making all the
 readmes to markdown file rather than text files, and a standard template?
 >
 >
 > --
 > Regards:
 > Pinkesh Sharma


 -
 To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
 For additional commands, e-mail: dev-h...@lucene.apache.org


>> --
>> Uwe Schindler
>> Achterdiek 19, 28357 Bremen
>> https://www.thetaphi.de
>>
>
>
> --
> Regards:
> Pinkesh Sharma
>


-- 
*Doug Turnbull **| CTO* | OpenSource Connections
, LLC | 240.476.9983
Author: Relevant Search 
This e-mail and all contents, including attachments, is considered to be
Company Confidential unless explicitly stated otherwise, regardless
of whether attachments are marked as such.

Re: [lucene-solr] branch master updated: Synchronizing 8.4.1 changes

[Jan Høydahl]

I just realized that since the 8.4.1 section wlll actually be part of the 8.5.0 
CHANGES file, there should be no doubt wrt this.

Thanks

> 22. jan. 2020 kl. 10:15 skrev Adrien Grand :
> 
> Given that 8.5.0 is not released yet, moving these entries from 8.5 to 8.4.1 
> feels consistent with instructions we have on the wiki: 
> https://cwiki.apache.org/confluence/display/lucene/ReleaseTodo#ReleaseTodo-SynchronizeCHANGES.txt
>  
> .
>  Indeed we would have duplicated entries if we were releasing 8.4.2 after 
> 8.5.0.
> 
> On Wed, Jan 22, 2020 at 9:58 AM Jan Høydahl  > wrote:
> Just a question about this commit.
> 
> These bug fixes released in 8.4.1 are also part of 8.5.0.
> 
> I thought we normally duplicated changes entries between a bugfix release and 
> the next minor version to avoid having to look at release dates and guess 
> whether the fixes are in the next minor or not.
> 
> Or I may remember wrong that we only follow this practice once we know that a 
> lower version will be released after a higher version (e.g. 8.4.2 after 
> 8.5.0).
> 
> Jan
> 
> > 22. jan. 2020 kl. 07:01 skrev is...@apache.org :
> > 
> > This is an automated email from the ASF dual-hosted git repository.
> > 
> > ishan pushed a commit to branch master
> > in repository https://gitbox.apache.org/repos/asf/lucene-solr.git 
> > 
> > 
> > 
> > The following commit(s) were added to refs/heads/master by this push:
> > new cc9c494  Synchronizing 8.4.1 changes
> > cc9c494 is described below
> > 
> > commit cc9c494a341d8f117b153145125a169bd8b95e6f
> > Author: Ishan Chattopadhyaya mailto:is...@apache.org>>
> > AuthorDate: Wed Jan 22 11:31:12 2020 +0530
> > 
> >Synchronizing 8.4.1 changes
> > ---
> > solr/CHANGES.txt | 6 --
> > 1 file changed, 6 deletions(-)
> > 
> > diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
> > index 8a84b01..4d0a5da 100644
> > --- a/solr/CHANGES.txt
> > +++ b/solr/CHANGES.txt
> > @@ -215,16 +215,10 @@ Bug Fixes
> > 
> > * SOLR-14017: Ensure bin/solr's -q and -v options work with examples (Andy 
> > Vuong via Jason Gerlowski)
> > 
> > -* SOLR-14106: Cleanup Jetty SslContextFactory usage (Ryan Rockenbaugh, Jan 
> > Hoydahl, Kevin Risden)
> > -
> > -* SOLR-14109: Always log to stdout from 
> > server/scripts/cloud-scripts/zkcli.{bat|sh} (janhoy)
> > -
> > * SOLR-14122: SimUtils converts v2 to v1 request params incorrectly. (Li 
> > Cao, ab)
> > 
> > * SOLR-13089: Fix lsof edge cases in the solr CLI script (Martijn Koster 
> > via janhoy)
> > 
> > -* SOLR-14163: SOLR_SSL_CLIENT_HOSTNAME_VERIFICATION needs to work with 
> > Jetty server/client SSL contexts (Kevin Risden)
> > -
> > * SOLR-6613: TextField.analyzeMultiTerm does not throw an exception when 
> > Analyzer returns no terms. (Bruno Roustant)
> > 
> > * SOLR-14192: Race condition between SchemaManager and ZkIndexSchemaReader. 
> > (ab)
> > 
> 
> 
> -
> To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org 
> 
> For additional commands, e-mail: dev-h...@lucene.apache.org 
> 
> 
> 
> 
> -- 
> Adrien

Re: [lucene-solr] branch master updated: Synchronizing 8.4.1 changes

[Adrien Grand]

Given that 8.5.0 is not released yet, moving these entries from 8.5 to
8.4.1 feels consistent with instructions we have on the wiki:
https://cwiki.apache.org/confluence/display/lucene/ReleaseTodo#ReleaseTodo-SynchronizeCHANGES.txt.
Indeed we would have duplicated entries if we were releasing 8.4.2 after
8.5.0.

On Wed, Jan 22, 2020 at 9:58 AM Jan Høydahl  wrote:

> Just a question about this commit.
>
> These bug fixes released in 8.4.1 are also part of 8.5.0.
>
> I thought we normally duplicated changes entries between a bugfix release
> and the next minor version to avoid having to look at release dates and
> guess whether the fixes are in the next minor or not.
>
> Or I may remember wrong that we only follow this practice once we know
> that a lower version will be released after a higher version (e.g. 8.4.2
> after 8.5.0).
>
> Jan
>
> > 22. jan. 2020 kl. 07:01 skrev is...@apache.org:
> >
> > This is an automated email from the ASF dual-hosted git repository.
> >
> > ishan pushed a commit to branch master
> > in repository https://gitbox.apache.org/repos/asf/lucene-solr.git
> >
> >
> > The following commit(s) were added to refs/heads/master by this push:
> > new cc9c494  Synchronizing 8.4.1 changes
> > cc9c494 is described below
> >
> > commit cc9c494a341d8f117b153145125a169bd8b95e6f
> > Author: Ishan Chattopadhyaya 
> > AuthorDate: Wed Jan 22 11:31:12 2020 +0530
> >
> >Synchronizing 8.4.1 changes
> > ---
> > solr/CHANGES.txt | 6 --
> > 1 file changed, 6 deletions(-)
> >
> > diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
> > index 8a84b01..4d0a5da 100644
> > --- a/solr/CHANGES.txt
> > +++ b/solr/CHANGES.txt
> > @@ -215,16 +215,10 @@ Bug Fixes
> >
> > * SOLR-14017: Ensure bin/solr's -q and -v options work with examples
> (Andy Vuong via Jason Gerlowski)
> >
> > -* SOLR-14106: Cleanup Jetty SslContextFactory usage (Ryan Rockenbaugh,
> Jan Hoydahl, Kevin Risden)
> > -
> > -* SOLR-14109: Always log to stdout from
> server/scripts/cloud-scripts/zkcli.{bat|sh} (janhoy)
> > -
> > * SOLR-14122: SimUtils converts v2 to v1 request params incorrectly. (Li
> Cao, ab)
> >
> > * SOLR-13089: Fix lsof edge cases in the solr CLI script (Martijn Koster
> via janhoy)
> >
> > -* SOLR-14163: SOLR_SSL_CLIENT_HOSTNAME_VERIFICATION needs to work with
> Jetty server/client SSL contexts (Kevin Risden)
> > -
> > * SOLR-6613: TextField.analyzeMultiTerm does not throw an exception when
> Analyzer returns no terms. (Bruno Roustant)
> >
> > * SOLR-14192: Race condition between SchemaManager and
> ZkIndexSchemaReader. (ab)
> >
>
>
> -
> To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
> For additional commands, e-mail: dev-h...@lucene.apache.org
>
>

-- 
Adrien

Re: [lucene-solr] branch master updated: Synchronizing 8.4.1 changes

[Jan Høydahl]

Just a question about this commit.

These bug fixes released in 8.4.1 are also part of 8.5.0.

I thought we normally duplicated changes entries between a bugfix release and 
the next minor version to avoid having to look at release dates and guess 
whether the fixes are in the next minor or not.

Or I may remember wrong that we only follow this practice once we know that a 
lower version will be released after a higher version (e.g. 8.4.2 after 8.5.0).

Jan

> 22. jan. 2020 kl. 07:01 skrev is...@apache.org:
> 
> This is an automated email from the ASF dual-hosted git repository.
> 
> ishan pushed a commit to branch master
> in repository https://gitbox.apache.org/repos/asf/lucene-solr.git
> 
> 
> The following commit(s) were added to refs/heads/master by this push:
> new cc9c494  Synchronizing 8.4.1 changes
> cc9c494 is described below
> 
> commit cc9c494a341d8f117b153145125a169bd8b95e6f
> Author: Ishan Chattopadhyaya 
> AuthorDate: Wed Jan 22 11:31:12 2020 +0530
> 
>Synchronizing 8.4.1 changes
> ---
> solr/CHANGES.txt | 6 --
> 1 file changed, 6 deletions(-)
> 
> diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
> index 8a84b01..4d0a5da 100644
> --- a/solr/CHANGES.txt
> +++ b/solr/CHANGES.txt
> @@ -215,16 +215,10 @@ Bug Fixes
> 
> * SOLR-14017: Ensure bin/solr's -q and -v options work with examples (Andy 
> Vuong via Jason Gerlowski)
> 
> -* SOLR-14106: Cleanup Jetty SslContextFactory usage (Ryan Rockenbaugh, Jan 
> Hoydahl, Kevin Risden)
> -
> -* SOLR-14109: Always log to stdout from 
> server/scripts/cloud-scripts/zkcli.{bat|sh} (janhoy)
> -
> * SOLR-14122: SimUtils converts v2 to v1 request params incorrectly. (Li Cao, 
> ab)
> 
> * SOLR-13089: Fix lsof edge cases in the solr CLI script (Martijn Koster via 
> janhoy)
> 
> -* SOLR-14163: SOLR_SSL_CLIENT_HOSTNAME_VERIFICATION needs to work with Jetty 
> server/client SSL contexts (Kevin Risden)
> -
> * SOLR-6613: TextField.analyzeMultiTerm does not throw an exception when 
> Analyzer returns no terms. (Bruno Roustant)
> 
> * SOLR-14192: Race condition between SchemaManager and ZkIndexSchemaReader. 
> (ab)
> 


-
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org