Simon Will
daf45a2993
Integrate Ubuntu 20 instructions into documentation
2020-05-07 00:36:13 +02:00
Simon Will
d351b10fde
Document minimum phpunit version
2020-05-06 23:47:16 +02:00
K Rahul Reddy
53949ace36
Removed redundant question
2020-05-06 21:26:32 +05:30
Sarah Hoffmann
c2f0d8e5ba
docs: add link to new status page
2020-05-04 21:11:57 +02:00
marc tobias
0fb93b1e8a
documenation for /status endpoint
2020-05-04 17:06:06 +02:00
Sarah Hoffmann
0e1e7c7df2
Merge pull request #1770 from lonvia/eyusupov-separate-compilation
...
Separate compilation
2020-04-26 21:48:43 +02:00
Sarah Hoffmann
77e7f4696b
fix docs typos
2020-04-26 15:00:28 +02:00
Sarah Hoffmann
47fb2c9126
cmake: restructure splitting between modules
...
Make a clear distinction between parts used for the importer
and parts used for the API.
2020-04-26 14:17:21 +02:00
Sarah Hoffmann
2740974a13
Merge pull request #1758 from krahulreddy/advanced-installations
...
Advanced installations
2020-04-22 09:59:44 +02:00
marc tobias
e33315eaa6
API documentation: clarification countrycode assignment happens using admin_level=2 tags
2020-04-21 17:42:12 +02:00
K Rahul Reddy
5c56ea3198
Adjustments made to documentation
2020-04-17 21:53:50 +05:30
K Rahul Reddy
42f86329a9
Added Advanced Installations documentation
2020-04-17 21:53:41 +05:30
filimongeorge
7f7d29fdd1
Updated Import and Update .md file
2020-04-09 20:51:38 +03:00
Sarah Hoffmann
975ef0b305
re-add district to geocodejson
2020-04-01 21:24:42 +02:00
Sarah Hoffmann
e59146a733
update documentation for geocodejson
...
Address parts should be usable now.
2020-04-01 11:17:25 +02:00
Sarah Hoffmann
e98619f801
docs: remove example with polygon parameter
...
This parameter was undocumented, long deprecated and is gone now.
2020-03-31 20:10:03 +02:00
Aakankasha Sharma
6603ad4006
Updated TIGER database link in documentation ( #1725 )
...
Updated TIGER database link in documentation
2020-03-27 15:50:05 +01:00
Sarah Hoffmann
c1ef56c870
advise against using Postgresql 12 and Postgis 3
...
See also #1677
2020-02-25 09:44:32 +01:00
Sarah Hoffmann
bb9bb40287
update cMake build documentation
...
Remove the dependency on libxml, no longer needed.
2020-01-24 22:53:26 +01:00
Sarah Hoffmann
2edc15dfb8
doc: clarify the influence of autovacuum on memory
2020-01-22 12:02:38 +01:00
Sarah Hoffmann
69e31baf68
docs: add a note that the faltnode file is needed for updates
...
Fixes #1644 .
2020-01-22 11:44:05 +01:00
Sarah Hoffmann
7005c6af12
add new extratags style
...
This is the same as the full style but also adds all unused tags
except for a couple of internal tags to the extratags column.
2020-01-02 14:24:51 +01:00
marc tobias
631013be02
Documentation: add FAQ entry about clang not found
2019-12-28 21:21:39 +01:00
marc tobias
22b7aed769
Use check_import_finished in test suite, document
2019-12-23 21:25:06 +01:00
Sarah Hoffmann
c36896c524
Merge pull request #1578 from lonvia/docs-installation-support
...
Update installation documentation wrt memory usage
2019-11-26 22:21:45 +01:00
Sarah Hoffmann
0bd006eef8
fix typo
2019-11-26 21:52:37 +01:00
Sarah Hoffmann
081d1f9779
Merge pull request #1582 from mtmail/documentation-direct-link-osm2pgsql
...
add wiki link to osm2psql README
2019-11-26 21:51:30 +01:00
marc tobias
05fb037edb
PHP PEAR::DB is not longer a prerequisite
2019-11-25 19:11:08 +01:00
marc tobias
5cdc196df1
add wiki link to osm2psql README
2019-11-25 19:08:34 +01:00
Sarah Hoffmann
88fab44006
update minimum required RAM to 64GB
...
Also adds more background explanation on time and RAM use,
as well as a hint that github issues are not good for
installation support.
2019-11-24 10:31:34 +01:00
Sarah Hoffmann
cd3ddec746
Switch to sql.gz format for wikipedia data
...
The dump import is no longer needed.
2019-11-17 10:09:31 +01:00
Sarah Hoffmann
d53af96aa4
update documentation for new wikipedia data
2019-11-16 16:52:23 +01:00
Sarah Hoffmann
6f2e767c77
Merge pull request #1557 from mtmail/document-boundingbox
...
documentation: add note what bounding box can be used for
2019-11-13 10:30:22 +01:00
Sarah Hoffmann
1ead5b0f3f
Merge pull request #1563 from mtmail/remove-pear-db-faq-entries
...
documentation: remove FAQ entries related to PEAR::DB
2019-11-13 10:29:52 +01:00
marc tobias
7503987630
typo in SQL in Postcodes.md
2019-11-11 23:34:44 +01:00
marc tobias
1d337e8a76
documentation: remove FAQ entries related to PEAR::DB, we no longer use that
2019-11-11 16:54:12 +01:00
Sarah Hoffmann
b5fb8608ba
some reformatting of documentation changes and typo fixes
...
The newest mkdocs is more demanding when it comes to code block
formatting.
2019-11-06 22:34:43 +01:00
marc tobias
dea1d67d03
documentation: new page explaining calculated postcodes
2019-11-06 22:15:44 +01:00
marc tobias
db6da75683
documentation: add note what bounding box can be used for
2019-11-06 17:33:20 +01:00
Sarah Hoffmann
26f47d2eb7
switch to pygments for mkdocs hilighting
2019-10-25 23:57:23 +02:00
Sarah Hoffmann
233e064f0b
prepare for 3.4.0 release
2019-10-25 22:04:59 +02:00
marc tobias
423efd54e4
documentation: add note what x,y mean for viewbox parameter
2019-10-08 19:22:51 +13:00
TC Haddad
5e45e0b3d7
Gsoc2019 contributions for adding Wikidata to Nominatim ( #1475 )
...
Complete rewrite of wikipedia processing scripts, addition of processing wikidata, new data source, new documentation by @tchaddad during Google Summer of Code 2019 project.
2019-10-06 15:56:39 +08:00
Christoffer Bo Petersen
ac7f0f7581
Remove duplicate format query param
2019-10-01 12:37:53 +02:00
marc tobias
74f49a9d89
US TIGER 2019 data got released
2019-08-23 14:59:03 +02:00
Sarah Hoffmann
7753ba6019
require python 3 for all tools used in updates
2019-07-28 20:36:35 +02:00
marc tobias
765a932561
make US postcode data to an optional download
2019-07-24 01:13:57 +02:00
Sarah Hoffmann
4a2c9431ee
Merge pull request #1432 from mtmail/two-outputformats-for-lookup-endpoint
...
lookup endpoint supports jsonv2 and geocodejson output now
2019-07-22 23:31:56 +02:00
marc tobias
1560685020
lookup endpoint supports jsonv2 and geocodejson output now
2019-07-21 23:20:48 +02:00
marc tobias
3b39cfb1cf
New readme file on how to build the documentation
2019-07-21 21:31:14 +02:00
Sarah Hoffmann
15bca71b0d
Merge pull request #1422 from lonvia/remove-country-from-addressline
...
Remove country from addressline
2019-07-16 22:29:17 +02:00
Sarah Hoffmann
927b4c928e
add migration hints for country table
2019-07-10 22:54:32 +02:00
André Santos
a4a17f93f5
Minor change on lookup endpoint doc
...
Fix documentation about lookup endpoint on output formats available on filter `format`
2019-07-10 19:26:38 +01:00
André Santos
bbc2da2a4b
Minor issue on api docs
...
Fix a minor issue on API docs in details endpoint example 🙏
2019-07-08 20:08:43 +01:00
Sarah Hoffmann
a09f2a6987
Merge pull request #1381 from mtmail/faq-entry-about-managed-database-services
...
FAQ entry about managed database services
2019-06-09 11:04:47 +02:00
Jochen Topf
251f335fe3
Revert layout changes in list.
2019-05-22 09:25:41 +02:00
Jochen Topf
634684236c
Fix some minor issues in docs.
2019-05-21 13:55:16 +02:00
marc tobias
11e0d9ec14
FAQ entry about managed database services
2019-05-14 19:45:56 +02:00
Sarah Hoffmann
c05ddb6119
increase minimum versions for PostgreSQL, Postgis and PHP
...
Remove checks and hacks for older versions.
2019-05-02 21:48:40 +02:00
Sarah Hoffmann
ec86a972a2
prepare for 3.3.0 release
2019-05-01 09:38:45 +02:00
Sarah Hoffmann
62da8a34f3
add documentation for new reverse zoom 17
2019-04-30 23:27:04 +02:00
marc tobias
2946e81995
New FAQ entry about -buffer is not owned by resource owner-
2019-03-19 01:52:35 +01:00
marc tobias
d4b633bfc5
replace database abstraction DB with PDO
2019-03-09 00:18:15 +01:00
Sarah Hoffmann
af97682cca
add hint that setup.php must be run from build directory
...
Fixes #1307 .
2019-02-13 21:58:59 +01:00
Sarah Hoffmann
cf4dcb12ed
docs: adapt sizes to smaller place_address table
2019-02-09 15:26:10 +01:00
Sarah Hoffmann
5dc10bd5a2
add final missing import numbers
2019-01-08 22:54:41 +01:00
Sarah Hoffmann
f1fe70656f
more style docs
2019-01-08 22:54:41 +01:00
Sarah Hoffmann
4c10294a29
document import style variants
2019-01-08 22:54:41 +01:00
Sarah Hoffmann
a90ace7fa1
add documentation for new import style
2019-01-08 22:54:41 +01:00
Sarah Hoffmann
fae8da2bcb
Merge pull request #1252 from mtmail/update-and-document-gb-postcode-data2
...
GB postcode: new conversion script, documentation
2018-12-04 22:20:55 +01:00
marc tobias
1489e6c00e
Explain place_id, i.e. shouldn't be use as permanent id
2018-12-03 19:05:18 +01:00
Marc Tobias Metten
61769a1bad
GB postcode: new conversion script, documentation
2018-12-03 18:43:28 +01:00
Sarah Hoffmann
121126cb50
Migration hint for address levels
2018-12-01 23:20:04 +01:00
Sarah Hoffmann
9a13086122
fixup typos and linking of data-source docs
...
Can't create symbolic links to a directory and then
to files within.
2018-12-01 22:40:37 +01:00
Sarah Hoffmann
c68833cd7f
Merge branch 'document-osm-country-grid' of https://github.com/mtmail/Nominatim
2018-12-01 22:20:50 +01:00
Sarah Hoffmann
d4fa528d5c
Merge pull request #1245 from lonvia/address-levels-from-json
...
Make rank assignments configurable
2018-12-01 21:43:53 +01:00
marc tobias
8e19336f49
document what country_osm_grid does
2018-11-29 17:06:04 +01:00
Sarah Hoffmann
e5cb5d439d
Merge pull request #1251 from mtmail/remove-naturalearth-boundary-fallback
...
remove Natural Earth dataset
2018-11-28 22:29:41 +01:00
RhinoDevel
313574ce97
Fix typo.
2018-11-28 13:11:06 +01:00
Sarah Hoffmann
96a84294f4
use consistent naming in doc pages
2018-11-27 22:59:18 +01:00
marc tobias
a7e26e8f59
remove Natural Earth dataset
2018-11-27 20:13:33 +01:00
Sarah Hoffmann
211214a8d3
Add documentation for new ranking level configuration
2018-11-24 16:21:16 +01:00
Sarah Hoffmann
1526501ed7
add documentation for reverse-only
2018-11-21 19:38:39 +01:00
Sarah Hoffmann
b15441df1c
Document the mmap requirement for flatnode files
...
Fixes #877 .
2018-11-17 15:37:46 +01:00
Sarah Hoffmann
36398eedca
docs: more specific chapter title
2018-11-15 23:01:08 +01:00
marc tobias
aa41b813b8
2018 TIGER data conversion scripts, add documentation to /docs/data-sources
2018-11-15 23:01:08 +01:00
Sarah Hoffmann
d1143b4580
docs: rewrite functions when migrating
...
Fixes #1183 .
2018-09-22 13:22:08 +02:00
marc tobias
71341a623a
Installation FAQ entry about a PHP warning that started with PHP7.2 [SKIP CI]
2018-09-20 13:41:43 +02:00
marc tobias
9b69bde613
three further FAQ entries regarding timezone, continents, exports
2018-09-19 19:31:54 +02:00
Sarah Hoffmann
bc26244114
docs: remove tablespace placeholder from index commands
...
Fixes #1171 .
2018-09-10 21:00:15 +02:00
Ganesh Krishnan
043f9d8298
allow nginx to serve files without php extensions
...
The apache config allows api calls without extension for eg /search?q=query string.
This does not work on nginx and we need to enable this via this patch
2018-08-29 12:59:29 -04:00
Sarah Hoffmann
b0d0d046e7
add migration for 3.2 version
2018-08-26 17:27:31 +02:00
Sarah Hoffmann
e09c42a78a
add docs for class parameter in /details
2018-08-26 16:40:52 +02:00
Sarah Hoffmann
6e3670bce5
add vagrant and installation instructions for ubuntu 18
2018-08-24 21:33:24 +02:00
Sarah Hoffmann
e7b738fe35
cleanup documentation
...
Remove level 3 (page title) from TOC and add permalinks.
Also fix and update some minor stuff in the docs.
2018-08-23 23:14:41 +02:00
Sarah Hoffmann
c80c80200c
fix links in details documentation
...
Thanks to @JamesKingdom.
2018-08-23 20:30:07 +02:00
marc tobias
4d38833170
documentation for /details endpoint
2018-08-22 13:55:43 +02:00
marc tobias
7081e2ab66
documentation for /details endpoint
2018-08-21 17:15:47 +02:00
marc tobias
71ae7f10f7
small typos and wording in the API docs
2018-08-20 19:11:38 +02:00
Sarah Hoffmann
569184a5b0
add FAQ from nominatim.org
2018-08-11 14:47:36 +02:00
Sarah Hoffmann
41c4b51be5
add description of output of API
2018-08-11 14:17:41 +02:00
Sarah Hoffmann
513bf485f2
clean up docs for lookup call
2018-08-11 09:24:59 +02:00
Sarah Hoffmann
263240919c
clean up and format search documentation
2018-08-09 23:06:52 +02:00
Sarah Hoffmann
d2b9493d72
clean up and format search documentation
2018-08-09 21:47:57 +02:00
marc tobias
92f86de938
FAQ: more answers regarding nominatim.so file permissions
2018-07-13 18:43:51 +02:00
marc tobias
879f818d81
add geojson,geocodejson formats to API documentation
2018-07-09 16:06:48 +02:00
marc tobias
a376608344
Update tiger install instructions. Mirror no longer working
2018-05-29 17:42:58 +02:00
Sarah Hoffmann
1d0da944a6
document polygon_threashold parameter
...
Fixes #1041 .
2018-05-15 23:30:58 +02:00
marc tobias
90d531c640
copied API endpoint documentation from wiki.osm.org to /docs
2018-03-19 17:10:22 +01:00
Sarah Hoffmann
de9507bc63
add develop section to documentation
2018-02-24 23:24:25 +01:00
marc tobias
d1f6fab68a
add links to docker, ansible respositories
2018-02-24 17:17:43 +01:00
Edward Betts
7e00a6e2ff
Correct spelling mistakes.
2018-02-18 13:11:35 +00:00
Sarah Hoffmann
d4110eef7e
improve syntax highlighting for vagrant scripts
2018-01-15 23:47:00 +01:00
Sarah Hoffmann
86833454a4
update vagrant scripts
2018-01-15 22:59:16 +01:00
Sarah Hoffmann
b8f7563da9
use mkdocs for compiling the documentation
...
Requires to shuffle around the documentation.
make doc will now compile the documentation
in the build directory. The markdowns created
from the vagrant files are no longer versioned.
2018-01-14 23:43:15 +01:00
Sarah Hoffmann
13469e1576
convert remaining http links and shorten copyright URL
2018-01-11 23:05:28 +01:00
Sarah Hoffmann
2cf1ff41c0
move nominatim.org links to https
...
Solves #737 .
2018-01-10 23:21:21 +01:00
Sarah Hoffmann
637c5c2936
add documentation for new word count compute
2017-12-17 16:00:28 +01:00
Sarah Hoffmann
cdabea7c76
docs: clarify how to run pip install
...
Fixes #792 .
2017-10-01 22:48:57 +02:00
Sarah Hoffmann
cf32da3748
docs: add more requirements for running tests
2017-09-16 22:11:39 +02:00
Sarah Hoffmann
5e54e78176
add migration path for postcodes
2017-08-19 19:37:06 +02:00
Frederik Ramm
bce11a5fc7
Mention explicitly that Osmosis is not required.
2017-07-21 09:23:38 +02:00
Andy Carra
8c087e4cb8
Warn about operation order with Wikipedia data
...
Give first-time users a tip about installing Wikipedia data before performing initial import.
once https://github.com/openstreetmap/Nominatim/issues/255 has been addressed, this note is no-longer important.
2017-07-14 18:52:54 -07:00
Srihari Thalla
d004a0e3df
Update file name of update.php to init updates
2017-07-07 15:57:01 +05:30
Srihari Thalla
97ad4e4654
Update incorrect internal links to docs
2017-06-29 17:29:15 +05:30
Sarah Hoffmann
7ef0239f19
make naming of documentation files consistent
2017-06-25 17:18:21 +02:00
Sarah Hoffmann
7448d3f171
recompile installation instructions
2017-06-09 20:12:29 +02:00
Sarah Hoffmann
e3fb706c65
add normalized version of special search terms on import
...
Requires the PHP bindings for libicu, so add that as a requirement.
2017-06-04 23:12:09 +02:00
Sarah Hoffmann
33c919ab09
Merge pull request #734 from lonvia/use-pyosmium-for-updates
...
Use pyosmium for updates
2017-05-26 21:43:08 +02:00
Sarah Hoffmann
65afe13f0a
update docs for osmosis to pyosmium change
2017-05-25 16:53:44 +02:00
Sarah Hoffmann
1a1526ec30
Add FAQ to documentation
...
For the moment only copies the FAQ entries for installation from the wiki and adds one on running multiple extracts.
2017-05-24 23:29:08 +02:00
Sarah Hoffmann
e7c8b498d1
update docs for new country grid location
...
Also updates some dependencies.
2017-05-13 00:13:56 +02:00
marc tobias
e24f53cb34
update docs/*.md based on vagrant/*.sh
2017-03-21 13:16:29 +01:00
Sarah Hoffmann
39c4c7fce8
add unzip tool to requirements for Tiger imports
...
Fixes #663
2017-03-15 20:44:06 +01:00
Sarah Hoffmann
a793f698f3
Merge pull request #660 from mtmail/new-github-URL
...
github.com/twain47 => github.com/openstreetmap
2017-03-12 13:59:11 +01:00
marc tobias
a52455f160
github.com/twain47 => github.com/openstreetmap
2017-03-12 13:06:25 +01:00
Edward Betts
7e3af2debc
correct spelling mistakes
2017-03-08 15:06:50 +00:00
Rory McCann
2fd9ffda43
Syntax improvements
...
use backticks for more fixed-width type things
2017-02-07 14:57:54 +01:00
Marc Tobias Metten
523873fe16
set directoryindex in Apache,nginx configuration
2016-12-16 02:16:47 +01:00
Sarah Hoffmann
b77e2503f5
drop support for PHP < 5.4
2016-10-17 22:28:39 +02:00
Sarah Hoffmann
a912b3448f
docs: fix link
2016-10-02 17:33:49 +02:00
Sarah Hoffmann
1982978f74
move country search term creation into setup script
...
Search results can become odd without the country search
terms, so make their inclusion a mandatory part of the
setup.
Also adds a new configuration variable to restrict the
languages taken into account by Nominatim.
2016-09-28 23:30:44 +02:00
Sarah Hoffmann
8a796db3c9
Merge pull request #508 from mtmail/addtype-in-installation.md
...
typo in Installation.md
2016-08-24 08:49:45 +02:00
mtmail
50c994be93
Update Installation.md
...
trivial typo: AddTpe => AddType
2016-08-24 01:45:36 +02:00
Sarah Hoffmann
9c1e0c49bf
docs: give recomendations about flatnode file size
...
closes #501
2016-08-10 22:02:10 +02:00
Sarah Hoffmann
36f2afea8a
mark checkpoint_segments parameter as deprecated
...
Postgresql 9.5 has checkpoint_segments removed and fails to start
if the options is given. Adds a comment to that effect.
Fixes #494 .
2016-08-04 22:17:05 +02:00
Sarah Hoffmann
3f06d9d3ba
fix typos and grammar in installation instructions
2016-07-26 20:38:44 +02:00
Sarah Hoffmann
8eb0e09ce3
more instructions for Tiger imports
2016-06-14 21:44:18 +02:00
Sarah Hoffmann
860acbf6af
add instructions to enable use of Tiger data
2016-06-13 20:07:57 +02:00
Sarah Hoffmann
91e1e4d614
fix formatting of docs
2016-06-08 23:17:48 +02:00