search

apache / lucene

Apache Lucene open-source search software
https://lucene.apache.org/
Apache License 2.0
2.64k stars 1.02k forks source link

Update demo documentation with prerequisites and ant target [LUCENE-5625] #6687

Open asfimport opened 10 years ago

asfimport commented 10 years ago

It would be great if the Lucene demo mentioned the fact that Apache Ant and Ivy need to be installed and configured to build the demo JARs. This could be listed in a prerequisites section.

It might also be a good idea to tell a first time user what ant target to use for building the JARs necessary for the demo.

Migrated from LUCENE-5625 by Joe Cabrera, updated Jun 14 2014

asfimport commented 10 years ago

Joe Cabrera (migrated from JIRA)

I have updated the demo documentation listing Ant and Ivy as prerequisites.

I have also listed the ant target to use for building JARs.

asfimport commented 10 years ago

ASF GitHub Bot (migrated from JIRA)

GitHub user greedo opened a pull request:

https://github.com/apache/lucene-solr/pull/56

proposed changes LUCENE-5625

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/greedo/lucene-solr trunk

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/lucene-solr/pull/56.patch

To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message:

This closes `#56`

commit aca11b889f1bca0500c0cec2e218c993884e0fa0 Author: Joe Cabrera <calcmaster16@gmail.com> Date: 2014-06-02T02:41:14Z

proposed changes LUCENE-5625
asfimport commented 10 years ago

Chris M. Hostetter (@hossman) (migrated from JIRA)

The existing demo overview.html assumes that all of the jars are already built: ie, that you have a binary release, or you have already figured out how to build lucene.

i'm not sure that adding specific verbage to this page talking about ant & ivy is really all that helpful – wouldn't it be better just to have a one line referal to BUILD.txt if they are dealing with a source only release?

asfimport commented 10 years ago

Joe Cabrera (migrated from JIRA)

I agree with your statement, however what if people do not know to look directly at BUILD.txt first to get the demo up and running?

asfimport commented 10 years ago

ASF GitHub Bot (migrated from JIRA)

GitHub user greedo opened a pull request:

https://github.com/apache/lucene-solr/pull/58

moved proposed changes LUCENE-5625 to BUILD.txt

moved the proposed changes to BUILD.txt based on comments

You can merge this pull request into a Git repository by running:

$ git pull https://github.com/greedo/lucene-solr trunk

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/lucene-solr/pull/58.patch

To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message:

This closes `#58`

commit 81e9a8429f7ae57ccbea2a3dbf0698d354430213 Author: Joe Cabrera <calcmaster16@gmail.com> Date: 2014-06-14T21:47:38Z

moved proposed changes LUCENE-5625 to BUILD.txt
asfimport commented 10 years ago

Joe Cabrera (migrated from JIRA)

Ok @hossman I have moved the proposed changes to BUILD.txt