hans/Nominatim
1
0
Fork 1
mirror of https://github.com/osm-search/Nominatim.git synced 2026-02-14 18:37:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

updates to admin and develop documentation

Browse Source 
Mostly minor updates in wording and resource consumption.
This commit is contained in:
Sarah Hoffmann
2020-12-06 17:28:33 +01:00
parent eaee87e73d
commit 603367dced
8 changed files with 52 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/develop/Development-Environment.md
View File

@@ -25,7 +25,7 @@ following packages should get you started:
## Prerequisites for testing and documentation
The Nominatim tests suite consists of behavioural tests (using behave) and
The Nominatim test suite consists of behavioural tests (using behave) and
unit tests (using PHPUnit). It has the following additional requirements:
* [behave test framework](https://behave.readthedocs.io) >= 1.2.5
@@ -85,7 +85,7 @@ All tests are located in the `\test` directory.
Some of the behavioural test expect a test database to be present. You need at
least 2GB RAM and 10GB disk space to create the database.
First create a separate directory for the test DB and Fetch the test planet
First create a separate directory for the test DB and fetch the test planet
data and the Tiger data for South Dakota:
```

6
docs/develop/Import.md
View File

@@ -1,8 +1,8 @@
# OSM Data Import
OSM data is initially imported using osm2pgsql. Nominatim uses its own data
output style 'gazetteer', which differs from the output style created for
map rendering.
OSM data is initially imported using [osm2pgsql](https://osm2pgsql.org).
Nominatim uses its own data output style 'gazetteer', which differs from the
output style created for map rendering.
## Database Layout

2
docs/develop/Ranking.md
View File

@@ -7,7 +7,7 @@ different purposes, which are explained in this chapter.
## Search rank
The search rank describes the extent and importance of a place. It is used
when ranking search result. Simply put, if there are two results for a
when ranking search results. Simply put, if there are two results for a
search query which are otherwise equal, then the result with the _lower_
search rank will be appear higher in the result list.

8
docs/develop/Testing.md
View File

@@ -27,7 +27,7 @@ This test directory is sturctured as follows:
## PHP Unit Tests (`test/php`)
Unit tests can be found in the php/ directory and tests selected php functions.
Unit tests can be found in the php/ directory. They test selected php functions.
Very low coverage.
To execute the test suite run
@@ -89,7 +89,7 @@ feature of behave which comes in handy when writing new tests.
### API Tests (`test/bdd/api`)
These tests are meant to test the different API endpoints and their parameters.
They require a to import several datasets into a test database.
They require to import several datasets into a test database.
See the [Development Setup chapter](Development-Environment.md#preparing-the-test-database)
for instructions on how to set up this database.
@@ -128,7 +128,7 @@ the [phpcov](https://github.com/sebastianbergmann/phpcov) tool:
These tests check the import and update of the Nominatim database. They do not
test the correctness of osm2pgsql. Each test will write some data into the `place`
table (and optionally `the planet_osm_*` tables if required) and then run
table (and optionally the `planet_osm_*` tables if required) and then run
Nominatim's processing functions on that.
These tests need to create their own test databases. By default they will be
@@ -139,4 +139,4 @@ needs superuser rights for postgres.
### Import Tests (`test/bdd/osm2pgsql`)
These tests check that data is imported correctly into the place table. They
use the same template database as the Indexing tests, so the same remarks apply.
use the same template database as the DB Creation tests, so the same remarks apply.

4
docs/develop/overview.md
View File

@@ -9,14 +9,14 @@ the address computation and the search frontend.
The __data import__ stage reads the raw OSM data and extracts all information
that is useful for geocoding. This part is done by osm2pgsql, the same tool
that can also be used to import a rendering database. It uses the special
gazetteer output plugin in `osm2pgsql/output-gazetter.[ch]pp`. The result of
gazetteer output plugin in `osm2pgsql/src/output-gazetter.[ch]pp`. The result of
the import can be found in the database table `place`.
The __address computation__ or __indexing__ stage takes the data from `place`
and adds additional information needed for geocoding. It ranks the places by
importance, links objects that belong together and computes addresses and
the search index. Most of this work is done in PL/pgSQL via database triggers
and can be found in the file `sql/functions.sql`.
and can be found in the files in the `sql/functions/` directory.
The __search frontend__ implements the actual API. It takes search
and reverse geocoding queries from the user, looks up the data and