From 8b8f954485a5634c12fe8f9c049521836f4a501c Mon Sep 17 00:00:00 2001 From: Julian Simioni Date: Wed, 25 Jul 2018 22:01:14 -0400 Subject: [PATCH 1/2] Initial development roadmap --- development_roadmap.md | 85 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 development_roadmap.md diff --git a/development_roadmap.md b/development_roadmap.md new file mode 100644 index 0000000..baf4ffe --- /dev/null +++ b/development_roadmap.md @@ -0,0 +1,85 @@ +# Development Roadmap + +Pelias has a long list of features and improvements we wish to make. This is +where we keep track of them! + +As an open-source project, we don't usually have a timeline or estimate for +when items on our roadmap will be completed, but this document does serve as a +roughly priority order of major changes we hope to make. + +## Solve the "postal cities" challenge + +Pelias uses strict geometric boundary decisions to determine what city (and +other administrative areas) a record belongs to. For various reasons, the real +world is not often so clear cut. + +Often, the city people expect to see for a given place has more to do with the +nuonces of local postal service delivery than strict borders. + +https://github.com/pelias/pelias/issues/396 + +## Improved Autocomplete + +Pelias has recently made many improvements to the search endpoint (which +supports only completed inputs), but has not brought all of them to the +autocomplete endpoint. Some features to implement: + +- Drop the requirement of commas to separate address components +- Better multi-language search support +- Improved handling of synonyms/abbreviations + +## Elasticsearch 5 Support + +Pelias is currently only compatible and well tested on Elasticsearch 2. While +the code changes required to support Elasticsearch 5 are minimal, testing and +validating Elasticsearch 5 as the default version is not complete and will +require significant work including testing full planet builds. + +https://github.com/pelias/pelias/issues/461 + +## Improved importer speed + +A full planet Pelias build currently generally takes 2-3 days. Many parts of +this import process can be sped up, and many more parts can be made more easily +parallelized. + +In the near future, our target is for a full planet build to take less than 24 +hours using under $100 of AWS EC2 instances. + +## Expanded input language support + +Overall, Pelias has a solid founation of language and internationalization +support. The Pelias data schema allows for records to have multiple name +values. These might include names in different langages, alternate names, +colloquial names, or common abbreviations (for example airport codes). + +However, not all data importers currently add multiple names, even when they +are available in the source data. Futhermore, not all our queries use these +alternate names effectively. + +Pelias currently supports querying for administrative areas in many languges on +the `/v1/search` endpoint. + +For autocomplete, the queries are not currently able to utilize multiple +administrative area names. + +Additionally, due to limitations in the polylines data format, no streets +imported from OSM include alternate names, even if they are available in OSM. + +## Fuzzy matching/typo correction for autocomplete + +The Pelias autocomplete endpoint currently supports extremely limited typo +correction. However, this support is really a result of implementation details, +and not a result of a concerted effort. + +By adding such a feature in a deliberate way we can greatly increase the +usability of the autocomplete endpoint. + +## Support for returning polygon data + +Pelias often returns records such as cities, states, countries, etc which have +polygons associated with them representing their boundaries. Pelias uses these +polygons for point-in-polygon lookups when necessary, but cannot currnely send +these polygons in the response JSON so that users can use that geometry data. + +https://github.com/pelias/whosonfirst/issues/19 From 39367dd738cf9f76b7689ca47c80d9a8f6d34487 Mon Sep 17 00:00:00 2001 From: Julian Simioni Date: Mon, 6 Aug 2018 16:15:29 -0400 Subject: [PATCH 2/2] =?UTF-8?q?Add=20link=20to=20development=20roadmap=20?= =?UTF-8?q?=F0=9F=9B=A3=EF=B8=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 311f6d0..3440f58 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ _Not sure which Endpoint to use? We have a [page](search-workflows.md) for that_ ### Pelias project development - [Release notes](release-notes.md). See notable changes in Pelias over time +- [Development roadmap](development_roadmap.md). Plans for future improvements to Pelias. Read this to see what's coming and how you can help ### Misc - [Glossary of common terms](glossary.md)