fix: relative links in documentation (#1791)

GIScience · May 13, 2024 · ec0feed · ec0feed
2 parents dd4d4d8 + c60080b
commit ec0feed
Show file tree

Hide file tree

Showing 18 changed files with 60 additions and 59 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -42,6 +42,7 @@ RELEASING:
 ### Fixed
 - preparation mode exiting with code 0 on fail ([#1772](https://github.com/GIScience/openrouteservice/pull/1772))
 - some more properties can be defined in a user's ors-config.yml/env ors.engine.profile_default without side effects (Issue [#1762](https://github.com/GIScience/openrouteservice/issues/1762))
+- relative links in documentation markdown sources ([#1791](https://github.com/GIScience/openrouteservice/pull/1791))
 
 ### Security
 - Fix CVEs GHSA-hgjh-9rj2-g67j, GHSA-ccgv-vj62-xf9h, GHSA-7w75-32cg-r6g2, GHSA-v682-8vv8-vpwr ([#1788](https://github.com/GIScience/openrouteservice/pull/1788))

diff --git a/docs/api-reference/endpoints/directions/extra-info/index.md b/docs/api-reference/endpoints/directions/extra-info/index.md
@@ -14,22 +14,22 @@ The desired extra info can be specified in the request body parameter `extra_inf
 
 The following table lists the possible values for the request as well as the keys and possible values in the directions response:
 
-| Request Value in `extra_info` | Description                                                                                                                                  | Key in Response `$.routes[*].extras` | Response Values                                           |
-|:-----------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------|-----------------------------------------------------------|
-|           steepness           | Provides information about how steep parts of the route are                                                                                  | `steepness`                          | [Steepness IDs](steepness.md)                             |
-|          suitability          | How suitable the way is based on characteristics of the route and the profile                                                                | `suitability`                        | 1 (unsuitable) - 10 (very suitable)                       |
-|            surface            | The surface covering along the route                                                                                                         | `surface`                            | [Surface IDs](surface.md)                                 |
-|          waycategory          | Specific categories of parts of the route (tollways, highways, fords etc.)                                                                   | `waycategory`                        | [Category IDs](waycategory.md)                            |
-|            waytype            | Types of roads and paths that are used in the route                                                                                          | `waytypes`¹                          | [Type IDs](waytype.md)                                    |
-|           tollways            | Any tollways that the route crosses. Whether a way is marked as [tollway](https://wiki.openstreetmap.org/wiki/Key:toll) depends on `profile` | `tollways`                           | 0 (no tollway) or 1 (tollway)                             |
-|        traildifficulty        | The difficulty of parts of the way based on sac or mountain bike scales                                                                       | `traildifficulty`                    | [Difficulty IDs](trail-difficulty.md)                     |
-|             osmid             | The [OpenStreetMap way IDs](https://wiki.openstreetmap.org/wiki/Elements#id) of the ways the route uses                                      | `osmId`¹                             |                                                           |
-|    roadaccessrestrictions     | Information about ways that may have access restrictions (e.g. private roads, destination only)                                              | `roadaccessrestrictions`             | [Restrictions IDs](road-access-restrictions.md)           |
-|          countryinfo          | Which country parts of the way lies in                                                                                                       | `countryinfo`                        | [Country IDs](/technical-details/country-list.md)         |
-|             green             | How "green" the parts of the route are (influenced by things like number of trees, parks, rivers etc.)                                       | `green`                              | 0 (minimal green-space) - 10 (a lot of green-space)       |
-|             noise             | How noisy the parts of the route are (influenced by things like proximity to highways)                                                       | `noise`                              | 0 (quiet) - 10 (noisy)                                    |
-|            shadow²            | How sunny the parts of the route are are                                                                                                     | `shadow`                             | 0 (completely in the shadow) - 10 (completely in the sun) |
-|             csv²              | Experimental feature: Generic extra information from provided csv file(s)                                                                    | `csv`                                | custom values                                             |
+| Request Value in `extra_info` | Description                                                                                                                                  | Key in Response `$.routes[*].extras` | Response Values                                              |
+|:-----------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------|--------------------------------------------------------------|
+|           steepness           | Provides information about how steep parts of the route are                                                                                  | `steepness`                          | [Steepness IDs](steepness.md)                                |
+|          suitability          | How suitable the way is based on characteristics of the route and the profile                                                                | `suitability`                        | 1 (unsuitable) - 10 (very suitable)                          |
+|            surface            | The surface covering along the route                                                                                                         | `surface`                            | [Surface IDs](surface.md)                                    |
+|          waycategory          | Specific categories of parts of the route (tollways, highways, fords etc.)                                                                   | `waycategory`                        | [Category IDs](waycategory.md)                               |
+|            waytype            | Types of roads and paths that are used in the route                                                                                          | `waytypes`¹                          | [Type IDs](waytype.md)                                       |
+|           tollways            | Any tollways that the route crosses. Whether a way is marked as [tollway](https://wiki.openstreetmap.org/wiki/Key:toll) depends on `profile` | `tollways`                           | 0 (no tollway) or 1 (tollway)                                |
+|        traildifficulty        | The difficulty of parts of the way based on sac or mountain bike scales                                                                      | `traildifficulty`                    | [Difficulty IDs](trail-difficulty.md)                        |
+|             osmid             | The [OpenStreetMap way IDs](https://wiki.openstreetmap.org/wiki/Elements#id) of the ways the route uses                                      | `osmId`¹                             |                                                              |
+|    roadaccessrestrictions     | Information about ways that may have access restrictions (e.g. private roads, destination only)                                              | `roadaccessrestrictions`             | [Restrictions IDs](road-access-restrictions.md)              |
+|          countryinfo          | Which country parts of the way lies in                                                                                                       | `countryinfo`                        | [Country IDs](../../../../technical-details/country-list.md) |
+|             green             | How "green" the parts of the route are (influenced by things like number of trees, parks, rivers etc.)                                       | `green`                              | 0 (minimal green-space) - 10 (a lot of green-space)          |
+|             noise             | How noisy the parts of the route are (influenced by things like proximity to highways)                                                       | `noise`                              | 0 (quiet) - 10 (noisy)                                       |
+|            shadow²            | How sunny the parts of the route are are                                                                                                     | `shadow`                             | 0 (completely in the shadow) - 10 (completely in the sun)    |
+|             csv²              | Experimental feature: Generic extra information from provided csv file(s)                                                                    | `csv`                                | custom values                                                |
 
 *¹ Note the different keys in request and response!*
 

diff --git a/docs/api-reference/endpoints/directions/routing-options.md b/docs/api-reference/endpoints/directions/routing-options.md
@@ -18,7 +18,7 @@ String value specifying which borders to avoid. Only for **`driving-*`** profile
 
 ### `options.avoid_countries` 
 An integer array of country ids to exclude from routing with **`driving-*`** profiles. Can be used together with `"avoid_borders": "controlled"`. 
-The list of countries and application examples can be found in the [country list](/technical-details/country-list.md).
+The list of countries and application examples can be found in the [country list](../../../technical-details/country-list.md).
 
 `"[11,193]"` would exclude Austria and Switzerland. 
 
@@ -107,7 +107,7 @@ An object with specifications of a round-trip:
 
 ### `options.vehicle_type`
 For `profile=driving-hgv` only.
-It is needed for **vehicle restrictions** to work (see [tag filtering](/technical-details/tag-filtering.md#driving-hgv)).
+It is needed for **vehicle restrictions** to work (see [tag filtering](../../../technical-details/tag-filtering.md#driving-hgv)).
 Possible values:
 
 * `hgv`

diff --git a/docs/api-reference/endpoints/export/index.md b/docs/api-reference/endpoints/export/index.md
@@ -3,7 +3,7 @@
 :::warning NOTE
 This endpoint is not available in the public API,
 but you can use it when running an own instance of openrouteservice.
-You can easily create requests with the [swagger-ui](/api-reference/index.md#swagger-ui).
+You can easily create requests with the [swagger-ui](../../index.md#swagger-ui).
 :::
 
 Export the base graph for different modes of transport.

diff --git a/docs/api-reference/endpoints/snapping/index.md b/docs/api-reference/endpoints/snapping/index.md
@@ -3,7 +3,7 @@
 :::warning NOTE
 This endpoint is not available in the public API,
 but you can use it when running an own instance of openrouteservice.
-You can easily create requests with the [swagger-ui](/api-reference/index.md#swagger-ui).
+You can easily create requests with the [swagger-ui](../../index.md#swagger-ui).
 :::
 
 The snapping endpoint can be used to snap points to the edges of the street network for a specific means of transportation.

diff --git a/docs/api-reference/index.md b/docs/api-reference/index.md
@@ -17,11 +17,11 @@ If you are developing ORS or running your own instance, you might benefit from t
 The [API Playground](https://openrouteservice.org/dev/#/api-docs/directions_service) is a complete, interactive and concise technical documentation of our live API.
 It can also be used to send sample requests to either our live API or an instance of openrouteservice running on your local machine.
 Use the form "API Server" on the top left to select and edit "Development Server" if you want to send requests to your local instance:
-![Development server usage](/playground-select-server.png "Development server usage"){ style="display: block; margin: 0 auto"}
+![Development server usage](../public/playground-select-server.png "Development server usage"){ style="display: block; margin: 0 auto"}
 
 The responses of your sample requests are visualized on a small map on the bottom right,
 but can also be shown as json, table or downloaded as file:
-![Example request visualization](/playground-map.png "Example request visualization"){ style="display: block; margin: 0 auto"}
+![Example request visualization](../public/playground-map.png "Example request visualization"){ style="display: block; margin: 0 auto"}
 
 ::: warning Hint
 If you prefer the swagger-ui you can also use the [swagger editor](https://editor-next.swagger.io/) and load
@@ -33,12 +33,12 @@ However, some of the displayed endpoints or features won't be accessible with ou
 
 Local instances of openrouteservice also have an accessible swagger-ui.
 This is a way to get an interactive API doc for your current or an older version of openrouteservice:
-1. Checkout the source code for the desired version or tag and [run the service locally](/run-instance/index.md).
+1. Checkout the source code for the desired version or tag and [run the service locally](../run-instance/index.md).
 2. You can then navigate to the swagger-ui hosted by your local instance in your browser: [http://localhost:8082/ors/swagger-ui/index.html](http://localhost:8082/ors/swagger-ui/index.html)
 (the port may be different on your local environment).
 
 :::warning Hint
 The swagger-ui is not available on the production ORS instances hosted by HeiGIT.
 :::
 
-![Swagger-UI](/swagger-ui.png "Swagger UI")
+![Swagger-UI](../public/swagger-ui.png "Swagger UI")
diff --git a/docs/contributing/index.md b/docs/contributing/index.md
@@ -16,7 +16,7 @@ please use the [corresponding repository](https://github.com/GIScience/ors-map-c
 
 ## Contributing code
 
-To help you get started, here is a document describing how to [build openrouteservice from code](/run-instance/building-from-source.md).
+To help you get started, here is a document describing how to [build openrouteservice from code](../run-instance/building-from-source.md).
 We also put together a few [guidelines](https://github.com/GIScience/openrouteservice/blob/main/CONTRIBUTE.md)
 to help you in the process and keep the repository clean and tidy.
 

diff --git a/docs/frequently-asked-questions.md b/docs/frequently-asked-questions.md
@@ -23,7 +23,7 @@ There are three main reasons for this problem, listed in order of most to least
    road. The maximum distance for snapping to road segments in our API is 350m.
  This can be customized for local installations via the
   `maximum_snapping_radius` and `location_index_resolution` config-parameter. See
-  [configuration](/run-instance/configuration/ors/engine/profiles.md) for details.
+  [configuration](run-instance/configuration/ors/engine/profiles.md) for details.
 
 3. The start and endpoint are passed with correct lon,lat-order and are within
    350m of a routable road. This should only happen with a local installation.
@@ -48,7 +48,7 @@ be preprocessed before the openrouteservice can start building the graphs used
 for routing.
 
 The build process in itself is [rather
-resource-intensive](/run-instance/system-requirements.md). It takes roughly two
+resource-intensive](run-instance/system-requirements.md). It takes roughly two
 days for any one of the nine profiles. For the mentioned resource requirements,
 this means that it will take roughly a week for all profiles to be re-built.
 
@@ -69,7 +69,7 @@ concern, if changes are not reflected within a month.
 
 ## I get an Error `Native memory allocation (mmap) failed to map 16384 bytes for committing reserved memory`
 
-See memory mapping section in [system requirements](/run-instance/system-requirements.md#memory-mapping-in-large-builds-with-a-containerized-openrouteservice-instance).
+See memory mapping section in [system requirements](run-instance/system-requirements.md#memory-mapping-in-large-builds-with-a-containerized-openrouteservice-instance).
 
 ## Why does routing not work when there is clearly a road?
 

diff --git a/docs/run-instance/building-from-source.md b/docs/run-instance/building-from-source.md
@@ -1,7 +1,7 @@
 # Building from Source
 
-If you need to customize your openrouteservice instance even further than what is possible by [configuration](/run-instance/configuration/index.md), you might need to make changes to the code. 
-If you implement features that might be useful for others as well, consider [contributing](/contributing/index.md)! The following instructions are useful to get you set up to start modifying the code.
+If you need to customize your openrouteservice instance even further than what is possible by [configuration](configuration/index.md), you might need to make changes to the code. 
+If you implement features that might be useful for others as well, consider [contributing](../contributing/index.md)! The following instructions are useful to get you set up to start modifying the code.
 
 
 ## Prerequisites

diff --git a/docs/run-instance/configuration/index.md b/docs/run-instance/configuration/index.md
@@ -31,9 +31,9 @@ At program start openrouteservice reports which configuration file was loaded.
 
 Depending on the artifact type, the configuration properties can be specified in different formats.
 Which format to use in which scenario is documented in the config documentations for 
-[JAR](/run-instance/running-jar.md),
-[WAR](/run-instance/running-war.md) and 
-[Docker](/run-instance/running-with-docker.md).
+[JAR](../running-jar.md),
+[WAR](../running-war.md) and 
+[Docker](../running-with-docker.md).
 
 * `.yml` is the default configuration format since version 8. You can find an [example configuration file](https://github.com/GIScience/openrouteservice/blob/main/ors-config.yml) with all available configuration options. Only a minimal set of properties is active, all others are commented out.
 * `.env` files for Docker setup. There is also an [example env file](https://github.com/GIScience/openrouteservice/blob/main/ors-config.env) that you can download and customize. 
@@ -80,7 +80,7 @@ The properties are organized in a hierarchical structure, with the following one
     * [ors.messages](ors/messages/index.md): System messages that can be sent with API responses following simple rules.
 
 At the very least, openrouteservice needs the configuration to contain an enabled [profile](ors/engine/profiles.md) and the
-reference to an [OSM data file](/run-instance/data.md#osm-data) to run properly. Therefore, the minimal valid content of such a file
+reference to an [OSM data file](../data.md#osm-data) to run properly. Therefore, the minimal valid content of such a file
 would be, e.g.:
 
 ```yaml
@@ -113,7 +113,7 @@ The options in order of precedence (higher options win over lower) are:
   ```
 
 The option to configure using environment variables is especially useful in contexts where you want to run
-openrouteservice in containers such as with [docker](/run-instance/running-with-docker.md). 
+openrouteservice in containers such as with [docker](../running-with-docker.md). 
 
 Every property also corresponds to an environment variable name in *uppercase letters* and with *underscores* replacing *dots*, so e.g.
 - `ORS_ENGINE_SOURCE_FILE` replaces `ors.engine.source_file`

diff --git a/docs/run-instance/configuration/ors/engine/profiles.md b/docs/run-instance/configuration/ors/engine/profiles.md
@@ -181,7 +181,7 @@ Properties beneath `ors.engine.profiles.*.ext_storages`:
 | Borders                | object | Borders allows the restriction of routes to not cross country borders, compatible for any profile type                       | [Borders](#borders)                               |
 
 
-Have a look at [this table](/api-reference/endpoints/directions/extra-info/index.md#extra-info-availability) to check which external storages are enabled for the which profile by default.
+Have a look at [this table](../../../../api-reference/endpoints/directions/extra-info/index.md#extra-info-availability) to check which external storages are enabled for the which profile by default.
 
 
 ### RoadAccessRestrictions