docs: Documentation for the config class migration and graph repo client

The documentation now includes information for the new configuration of ors. The configuration is now differently structured and thus content moved a lot. Additionally, the graph download functionality is described. Co-authored-by: Takara Baumbach <31958783+takb@users.noreply.github.com>
GIScience · Nov 8, 2024 · 17ae5df · 17ae5df
1 parent 7d3aaad
commit 17ae5df
Show file tree

Hide file tree

Showing 43 changed files with 3,404 additions and 960 deletions.
diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js
@@ -1,7 +1,15 @@
-import {defineConfig} from 'vitepress'
+import {withMermaid} from "vitepress-plugin-mermaid";
 
 // https://vitepress.dev/reference/site-config
-export default defineConfig({
+export default withMermaid({
+    mermaid: {
+        // refer https://mermaid.js.org/config/setup/modules/mermaidAPI.html#mermaidapi-configuration-defaults for options
+    },
+    // optionally set additional config for plugin itself with MermaidPluginConfig
+    mermaidPlugin: {
+        // class: "mermaid my-class", // set additional css classes for parent container
+    },
+
     title: "openrouteservice backend documentation",
     description: "openrouteservice backend documentation",
     base: "/openrouteservice/",
@@ -85,7 +93,7 @@ export default defineConfig({
                                     {text: 'Isochrones', link: '/api-reference/endpoints/isochrones/'},
                                     {text: 'Matrix', link: '/api-reference/endpoints/matrix/'},
                                     {text: 'Snapping', link: '/api-reference/endpoints/snapping/'},
-                                    {text: 'Export', link: '/api-reference/endpoints/export/'},
+                                    {text: 'Export (not live)', link: '/api-reference/endpoints/export/'},
                                     {text: 'Health (not live)', link: '/api-reference/endpoints/health/'},
                                     {text: 'Status (not live)', link: '/api-reference/endpoints/status/'},
                                     {text: 'POI', link: '/api-reference/endpoints/poi/'},
@@ -109,33 +117,62 @@ export default defineConfig({
                             {
                                 text: 'Configuration', collapsed: true, link: '/run-instance/configuration/',
                                 items: [
-                                    {text: 'Spring Properties', link: '/run-instance/configuration/spring/', collapsed:true,
+                                    {text: 'server', link: '/run-instance/configuration/server.md'},
+                                    {text: 'logging', link: '/run-instance/configuration/logging.md'},
+                                    {
+                                        text: 'ors.endpoints',
+                                        link: '/run-instance/configuration/endpoints/',
+                                        collapsed: true,
                                         items: [
-                                            {text: 'server', link: '/run-instance/configuration/spring/server.md'},
-                                            {text: 'logging', link: '/run-instance/configuration/spring/logging.md'},
+                                            {
+                                                text: 'defaults',
+                                                link: '/run-instance/configuration/endpoints/defaults.md'
+                                            },
+                                            {text: 'routing', link: '/run-instance/configuration/endpoints/routing.md'},
+                                            {text: 'matrix', link: '/run-instance/configuration/endpoints/matrix.md'},
+                                            {
+                                                text: 'isochrones',
+                                                link: '/run-instance/configuration/endpoints/isochrones.md'
+                                            },
+                                            {text: 'snap', link: '/run-instance/configuration/endpoints/snap.md'},
                                         ]
                                     },
-                                    {text: 'ORS Properties', collapsed:true,
+                                    {
+                                        text: 'ors.engine',
+                                        link: '/run-instance/configuration/engine/',
+                                        collapsed: true,
                                         items: [
-                                            {text: 'endpoints', link: '/run-instance/configuration/ors/endpoints/', collapsed: true,
-                                                items: [
-                                                    {text: 'defaults', link: '/run-instance/configuration/ors/endpoints/defaults.md'},
-                                                    {text: 'routing', link: '/run-instance/configuration/ors/endpoints/routing.md'},
-                                                    {text: 'matrix', link: '/run-instance/configuration/ors/endpoints/matrix.md'},
-                                                    {text: 'isochrones', link: '/run-instance/configuration/ors/endpoints/isochrones.md'},
-                                                    {text: 'snap', link: '/run-instance/configuration/ors/endpoints/snap.md'},
-                                                ]
+                                            {
+                                                text: 'graph_management',
+                                                link: '/run-instance/configuration/engine/graph-management.md'
                                             },
-                                            {text: 'engine', link: '/run-instance/configuration/ors/engine/', collapsed: true,
+                                            {
+                                                text: 'elevation',
+                                                link: '/run-instance/configuration/engine/elevation.md'
+                                            },
+                                            {
+                                                text: 'profiles',
+                                                link: '/run-instance/configuration/engine/profiles/',
+                                                collapsed: true,
                                                 items: [
-                                                    {text: 'profiles', link: '/run-instance/configuration/ors/engine/profiles.md'},
-                                                    {text: 'elevation', link: '/run-instance/configuration/ors/engine/elevation.md'},
+                                                    {
+                                                        text: 'build',
+                                                        link: '/run-instance/configuration/engine/profiles/build.md'
+                                                    },
+                                                    {
+                                                        text: 'repo',
+                                                        link: '/run-instance/configuration/engine/profiles/repo.md'
+                                                    },
+                                                    {
+                                                        text: 'service',
+                                                        link: '/run-instance/configuration/engine/profiles/service.md'
+                                                    },
                                                 ]
                                             },
-                                            {text: 'cors', link: '/run-instance/configuration/ors/cors/'},
-                                            {text: 'messages', link: '/run-instance/configuration/ors/messages/'}
                                         ]
                                     },
+                                    {text: 'ors.cors', link: '/run-instance/configuration/cors/'},
+                                    {text: 'ors.messages', link: '/run-instance/configuration/messages/'},
                                     {text: 'JSON config (deprecated)', link:'/run-instance/configuration/json.md'}
                                 ]
                             },
@@ -161,7 +198,8 @@ export default defineConfig({
                                     {text: 'Surface Speeds', link: '/technical-details/travel-speeds/surface-speeds.md'},
                                 ]
                             },
-                            {text: 'Tag Filtering', link: '/technical-details/tag-filtering'}
+                            {text: 'Tag Filtering', link: '/technical-details/tag-filtering'},
+                            {text: 'Graph Management', link: '/technical-details/graph-repo-client/'},
                         ]
                     },
                     {text: 'FAQ', link: '/frequently-asked-questions'}

diff --git a/docs/api-reference/endpoints/directions/extra-info/index.md b/docs/api-reference/endpoints/directions/extra-info/index.md
@@ -47,7 +47,6 @@ Some values are not available in all routing profiles:
 | cycling-regular  |     x     |      x      |    x    |      x      |    x    |          |        x        |       |                        |             |       |       |        |
 | cycling-mountain |     x     |      x      |    x    |      x      |    x    |          |        x        |       |                        |             |       |       |        |
 | cycling-road     |     x     |      x      |    x    |      x      |    x    |          |        x        |       |                        |             |       |       |        |
-| cycling-electric |     x     |      x      |    x    |      x      |    x    |          |        x        |       |                        |             |       |       |        |
 | foot-walking     |     x     |      x      |    x    |      x      |    x    |          |        x        |       |                        |             |   x   |   x   |   x    |
 | foot-hiking      |     x     |      x      |    x    |      x      |    x    |          |        x        |       |                        |             |   x   |   x   |   x    |
 | wheelchair       |     x     |      x      |    x    |      x      |    x    |          |        x        |   x   |                        |             |       |       |        |

diff --git a/docs/api-reference/endpoints/directions/routing-options.md b/docs/api-reference/endpoints/directions/routing-options.md
@@ -5,9 +5,6 @@ With the request body parameter `options`, advanced routing options can be speci
 The `options` parameter is a JSON object, multiple of the here mentioned parameters can be set. 
 For structure refer to the [examples](#examples).
 
-::: warning
-Some of the options below rely on auxiliary data included in the graph, see [External storages](../../../run-instance/configuration/ors/engine/profiles.md#ext_storages)
-:::
 
 ## Available parameters
 

diff --git a/docs/api-reference/endpoints/export/index.md b/docs/api-reference/endpoints/export/index.md
@@ -1,5 +1,11 @@
 # Export Endpoint
 
+:::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](../../index.md#swagger-ui).
+:::
+
 Export the base graph for different modes of transport.
 
 In the request, the desired routing profile is specified as the last path parameter, 

diff --git a/docs/api-reference/endpoints/index.md b/docs/api-reference/endpoints/index.md
@@ -13,12 +13,12 @@ Openrouteservice offers a set of endpoints for different spatial purposes:
 * [Isochrones Service](isochrones/index.md): Obtain areas of reachability from given locations
 * [Matrix Service](matrix/index.md): Obtain one-to-many, many-to-one and many-to-many matrices for time and distance
 * [Snapping Service](snapping/index.md): Snap coordinates to the road network
-* [Export Service](export/index.md): Export the base graph for different modes of transport
 
 ## Technical Endpoints
 
 Furthermore, there are technical endpoints that are :warning: _not available_ in our live API:
 
+* [Export Service](export/index.md): Export the base graph for different modes of transport
 * [Health Service](health/index.md): Get information on the health of the running openrouteservice instance
 * [Status Service](status/index.md): Get information on the status of the openrouteservice instance
 

diff --git a/docs/api-reference/index.md b/docs/api-reference/index.md
@@ -8,7 +8,8 @@ The following chapter [Endpoints](endpoints/index.md) contains explanation and e
 be explained sufficiently in the API Playground.
 Here, the single endpoints are not completely covered with all their request parameters etc.
 But on the other hand, there is also information about endpoints that are not available in our live API,
-but e.g. on instances you run or host yourself like [Health](endpoints/health/index.md) and [Status](endpoints/status/index.md).
+but e.g. on instances you run or host yourself
+like [Export](endpoints/export/index.md), [Health](endpoints/health/index.md) and [Status](endpoints/status/index.md).
 
 If you are developing ORS or running your own instance, you might benefit from the included [Swagger-UI](#swagger-ui).
 

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/engine/profiles/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.

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -8,7 +8,7 @@ The fastest way to get to the info you are looking for is **the search bar above
   * [Isochrones](api-reference/endpoints/isochrones/index.md) endpoint
   * [Matrix](api-reference/endpoints/matrix/index.md) endpoint
   * [Snapping](api-reference/endpoints/snapping/index.md) endpoint
-  * [Export](api-reference/endpoints/export/index.md) endpoint
+  * [Export](api-reference/endpoints/export/index.md) endpoint _(not available in our live API)_
 * [Run ORS instance](run-instance/index.md) contains all info about setting up the ors locally. 
   * [System requirements](run-instance/system-requirements)
   * [Data](run-instance/data) used by openrouteservice