Update demo documentation with prerequisites and ant target [LUCENE-5625]
Open
affects-version:4.7.2
legacy-jira-fix-version:4.7.2
legacy-jira-label:documentation
legacy-jira-priority:Trivial
type:documentation
type:enhancement
website
- Dominant language
- Java
- Stars
- 3.6k
- Forks
- 1.4k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 88
Description
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](https://issues.apache.org/jira/browse/LUCENE-5625) by Joe Cabrera, updated Jun 14 2014
Contributor guide
Research direction
Locate the Lucene demo documentation and its build instructions. Add a prerequisites section covering Apache Ant and Ivy, identify the Ant target that builds the demo JARs, and verify that the instructions clearly tell a first-time user how to build them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100