docs: add warning for profile_default settings (#1764)

GIScience · Mar 26, 2024 · 14c28f5 · 14c28f5
2 parents 4a2e936 + ccd35bd
commit 14c28f5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/run-instance/configuration/ors/engine/index.md b/docs/run-instance/configuration/ors/engine/index.md
@@ -3,6 +3,12 @@
 
 Engine properties are required at graph-build time during startup.
 
+::: warning
+If you specified `profile_default` settings they might not be taken into account!
+This will be fixed in the next patch release.
+As a workaround, you can move all `profile_default` settings to the specific profile where you need them to work.
+:::
+
 | key                | type    | description                                                                                                                                                                                                                                                                                          | default value                              |
 |--------------------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|
 | init_threads       | number  | The number of threads used to initialize (build/load) graphs. Higher numbers requires more RAM                                                                                                                                                                                                       | `1`                                        |

diff --git a/docs/run-instance/configuration/ors/engine/profiles.md b/docs/run-instance/configuration/ors/engine/profiles.md
@@ -15,6 +15,12 @@ Available profiles are:
 - `wheelchair`
 - `public-transport`
 
+::: warning
+If you specified `profile_default` settings they might not be taken into account! 
+This will be fixed in the next patch release.
+As a workaround, you can move all `profile_default` settings to the specific profile where you need them to work.
+:::
+
 Properties for each (enabled) profile are set under `ors.engine.profiles.<profile>`, e.g.
 - `ors.engine.profiles.car`
 - `ors.engine.profiles.hiking`