apache / apache/lucene

Improve spatial package.html to compare Strategys [LUCENE-4223]

Open
#5,295 1 comment 0 reactions 0 assignees View on GitHub
legacy-jira-priority:Minor module:spatial type:enhancement
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

Spin off from #5245. One of the most important parts of using the spatial module is deciding which Strategy fits your needs. We should improve the package.html documentation so that it compares the Strategys, focusing on:

- Underlying index format (lon/lat numeric fields vs grid terms vs ...)
- Multi-value support
- Indexable Shapes
- Queryable Shapes
- Query operations

---
Migrated from [LUCENE-4223](https://issues.apache.org/jira/browse/LUCENE-4223) by Chris Male, updated Jul 23 2012

Contributor guide

Open the contributing guide

Research direction

Start with the spatial module's package.html and inspect the available Strategies and their existing documentation. Update the comparison to cover underlying index format, multi-value support, indexable and queryable shapes, and query operations; done means users can compare the Strategies against all listed criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation, search
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.