Skip to content

Commit

Permalink
docs(configuration): fix missing 'build' in paths
Browse files Browse the repository at this point in the history 
also unify the placeholder for profiles in properties and make it readable more informative
  • Loading branch information
@jhaeu
jhaeu committed Jan 17, 2025
1 parent 514764f commit 6538185
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 24 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ RELEASING:

### Fixed
- NPE in error handling ([#1925](https://github.com/GIScience/openrouteservice/pull/1925))
- Add missing 'build' in documentation for profile
properties ([#1947](https://github.com/GIScience/openrouteservice/issues//1947))

### Security

Expand Down
21 changes: 11 additions & 10 deletions docs/run-instance/configuration/engine/profiles/build.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `ors.engine.profiles.<profile>.build`
# `ors.engine.profiles.<PROFILE-NAME>.build`

Properties beneath `ors.engine.profiles.<profile>.build` are used to define the parameters for building the routing
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.build` are used to define the parameters for building the routing
graphs for the specified profile.

| key | type | description | default value |
Expand All @@ -19,11 +19,11 @@ graphs for the specified profile.
| gtfs_file | string | Only for `public-transport` profile: location of GTFS data; can either be a zip-file or the unzipped folder | _NA_ |
| encoder_options | string | For details see [encoder_options](#encoder-options) below | |
| preparation | object | [Preparation settings](#preparation) for building the routing graphs | |
| ext_storages | object | [External storages](#ext_storages) for returning extra information | |
| ext_storages | object | [External storages](#ext-storages) for returning extra information | |

## `encoder_options`

Properties beneath `ors.engine.profiles.*.encoder_options`:
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.build.encoder_options`:

| key | type | profiles | description | example value |
|--------------------------|---------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
Expand All @@ -37,7 +37,7 @@ Properties beneath `ors.engine.profiles.*.encoder_options`:

## `preparation`

Properties beneath `ors.engine.profiles.*.preparation`:
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.build.preparation`:

| key | type | description | default value |
|------------------|--------|-------------------------------------------------------------------|---------------|
Expand All @@ -48,7 +48,7 @@ Properties beneath `ors.engine.profiles.*.preparation`:

Settings for preprocessing contraction hierarchies

Properties beneath `ors.engine.profiles.*.preparation.methods.ch`:
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.build.preparation.methods.ch`:

| key | type | description | example value |
|------------|---------|----------------------------------------------------------|------------------------|
Expand All @@ -60,7 +60,7 @@ Properties beneath `ors.engine.profiles.*.preparation.methods.ch`:

Settings for preprocessing A* with landmarks

Properties beneath `ors.engine.profiles.*.preparation.methods.lm`:
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.build.preparation.methods.lm`:

| key | type | description | default value |
|------------|---------|---------------------------------------------------------------------------------------------------------------------------|------------------------|
Expand All @@ -73,7 +73,7 @@ Properties beneath `ors.engine.profiles.*.preparation.methods.lm`:

Settings for preprocessing core routing with landmarks

Properties beneath `ors.engine.profiles.*.preparation.methods.core`:
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.build.preparation.methods.core`:

| key | type | description | example value |
|------------|---------|-----------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
Expand Down Expand Up @@ -110,7 +110,7 @@ parameter
rely on the `HeavyVehicle` storage.
:::

Properties beneath `ors.engine.profiles.*.ext_storages`:
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.build.ext_storages`:

| key | type | description | example value |
|------------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|
Expand Down Expand Up @@ -152,7 +152,8 @@ route response.

### `Borders`

Properties beneath `ors.engine.profiles.*.ext_storages.Borders` allows to define restriction of routes to not cross
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.build.ext_storages.Borders` allows to define restriction of
routes to not cross
country borders, compatible with any profile type.

| key | type | description | example value |
Expand Down
4 changes: 2 additions & 2 deletions docs/run-instance/configuration/engine/profiles/repo.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `ors.engine.profiles.<profile>.repo`
# `ors.engine.profiles.<PROFILE-NAME>.repo`

Properties beneath `ors.engine.profiles.<profile>.repo` are used to address a graph in a graph repository.
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.repo` are used to address a graph in a graph repository.
If *all* of these properties are set,
and if graph management is
enabled [ors.engine.graph_management.enabled](/run-instance/configuration/engine/graph-management.md),
Expand Down
14 changes: 8 additions & 6 deletions docs/run-instance/configuration/engine/profiles/service.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# `ors.engine.profiles.<profile>.service`
# `ors.engine.profiles.<PROFILE-NAME>.service`

Properties beneath `ors.engine.profiles.<profile>.service` represent parameters relevant when querying services that
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.service` represent parameters relevant when querying services
that
need to be set specifically for each profile. More parameters relevant at query time can be found in the [
`ors.endpoints`](/api-reference/endpoints/index.md) section.

Expand All @@ -19,13 +20,14 @@ need to be set specifically for each profile. More parameters relevant at query

## `execution`

Properties beneath `ors.engine.profiles.<profile>.service.execution` represent options specific for certain algorithms.
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.service.execution` represent options specific for certain
algorithms.

### `methods.astar`

Parameters for beeline approximation in the A* routing algorithm.

Properties beneath `ors.engine.profiles.<profile>.service.execution.methods.astar`:
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.service.execution.methods.astar`:

| key | type | description | default value |
|---------------|--------|---------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
Expand All @@ -36,7 +38,7 @@ Properties beneath `ors.engine.profiles.<profile>.service.execution.methods.asta

Settings for using landmarks in routing.

Properties beneath `ors.engine.profiles.<profile>.service.execution.methods.lm`:
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.service.execution.methods.lm`:

| key | type | description | default value |
|------------------|--------|--------------------------------------------------|---------------|
Expand All @@ -46,7 +48,7 @@ Properties beneath `ors.engine.profiles.<profile>.service.execution.methods.lm`:

Settings for using landmarks in routing using the Core-ALT algorithm.

Properties beneath `ors.engine.profiles.<profile>.service.execution.methods.core`:
Properties beneath `ors.engine.profiles.<PROFILE-NAME>.service.execution.methods.core`:

| key | type | description | example value |
|------------------|--------|--------------------------------------------------|---------------|
Expand Down
2 changes: 1 addition & 1 deletion docs/run-instance/configuration/how-to-configure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ The internal value for the specific profile wins over the user's `profile_defaul

## Graph build properties loaded from graph directories

The configured profile properties in `ors.engine.profiles.<profile>.build` (and `ors.engine.profile_default.build`)
The configured profile properties in `ors.engine.profiles.<PROFILE-NAME>.build` (and `ors.engine.profile_default.build`)
are used to _build_ a graph.
openrouteservice stores these build properties in the file `graphs/<profile>/graph_build_info.yml` when a graph is
computed.
Expand Down
8 changes: 5 additions & 3 deletions docs/run-instance/data.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,20 @@ Note, that while the dataset was published in 2023, the most recent data contain
### Borders
Data relating to the avoid borders features is derived from administrative boundaries features in OpenStreetMap. Information about open borders is obtained from [Wikipedia](https://en.wikipedia.org/wiki/Open_border).

Configuration parameters: [`ors.engine.profiles.*.ext_storages.Borders`](configuration/engine/profiles/build.md#borders)
Configuration parameters: [
`ors.engine.profiles.<PROFILE-NAME>.ext_storages.Borders`](configuration/engine/profiles/build.md#borders)

### GTFS
The public transport profile integrates [GTFS](https://developers.google.com/transit/gtfs) data for the public transit part. GTFS feeds can be obtained e.g. from sites like https://gtfs.de/ (for Germany), or from local public transport operators.

Configuration parameters: [`ors.engine.profiles.*.gtfs_file`](configuration/engine/profiles/build.md)
Configuration parameters: [`ors.engine.profiles.<PROFILE-NAME>.gtfs_file`](configuration/engine/profiles/build.md)

### Green & Quiet
The data used to identify green and quiet routes were derived from research projects in the GIScience research group at Heidelberg University.
More information about these can be found on the GIScience news blog [here](https://giscienceblog.uni-heidelberg.de/2017/07/03/healthy-routing-prefering-green-areas-added-to-openrouteserviceorg/) and [here](http://giscienceblog.uni-heidelberg.de/2017/07/10/reducing-stress-by-avoiding-noise-with-quiet-routing-in-openrouteservice/)

Configuration parameters: [`ors.engine.profiles.*.ext_storages`](configuration/engine/profiles/build.md#ext_storages)
Configuration parameters: [
`ors.engine.profiles.<PROFILE-NAME>.ext_storages`](configuration/engine/profiles/build.md#ext_storages)


## Output Files
Expand Down
4 changes: 2 additions & 2 deletions docs/technical-details/graph-repo-client/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ go in touch with us to discuss if we can calculate the required graphs for you a

The local directory, where openrouteservice stores and loads graphs, is defined by the configuration property
`graph_path`
(in `ors.engine.profile_default` or in a single profile in `ors.engine.profiles.<profile>.graph_path`).
(in `ors.engine.profile_default` or in a single profile in `ors.engine.profiles.<PROFILE-NAME>.graph_path`).
The graphs are located in sub directories named like their routing profiles.

E.g. with `ors.engine.profile_default.graph_path: /home/ors/graphs` and the enabled profiles `car` and `bike`,
Expand Down Expand Up @@ -338,7 +338,7 @@ The general graph management is configured in the config properties beneatch [

To define a graph in the openrouteservice config, configuration parameters similar to the elements of
the [repository structure](#repository-structure) are used
(see also [`ors.engine.profiles.<profile>.repo`](/run-instance/configuration/engine/profiles/repo.md)):
(see also [`ors.engine.profiles.<PROFILE-NAME>.repo`](/run-instance/configuration/engine/profiles/repo.md)):

| Repo Path Parameter | Configuration Parameter |
|----------------------------|---------------------------------------------------------------------------------------|
Expand Down

0 comments on commit 6538185

Please sign in to comment.