docs: revert to 1 level less in run-instance

.gitignore

@@ -19,8 +19,7 @@ docker/
 
 # Ignore all ors-config files except for the sample one, useful for development and testing
 ors-api/src/main/resources/ors-config*
-!ors-api/src/main/resources/ors-config-sample.json
-ors-api/ors-config.yml
+ors-config*
 
 envs/
 ors-config-repo/

docs/.vitepress/config.js

@@ -96,40 +96,10 @@ export default defineConfig({
                         items: [
                             {text: 'System Requirements', link: '/run-instance/system-requirements'},
                             {text: 'Data', link: '/run-instance/data'},
-                            {text: 'ORS as JAR', collapsed: true, link: '/run-instance/jar/index.md',
-                                items: [
-                                    {text: 'build', link: '/run-instance/jar/build.md'},
-                                    {text: 'download', link: '/run-instance/jar/download.md'},
-                                    {text: 'configure', link: '/run-instance/jar/configure.md'},
-                                    {text: 'run', link: '/run-instance/jar/run.md'},
-                                    {text: 'troubleshoot', link: '/run-instance/jar/troubleshoot.md'}
-                                ]},
-                            {text: 'ORS as Docker Container (JAR)', collapsed: true, link: '/run-instance/jar-docker/index.md',
-                                items: [
-                                    {text: 'build', link: '/run-instance/jar-docker/build.md'},
-                                    {text: 'download', link: '/run-instance/jar-docker/download.md'},
-                                    {text: 'configure', link: '/run-instance/jar-docker/configure.md'},
-                                    {text: 'run', link: '/run-instance/jar-docker/run.md'},
-                                    {text: 'troubleshoot', link: '/run-instance/jar-docker/troubleshoot.md'}
-                                ]},
-                            {text: 'ORS as WAR', collapsed: true, link: '/run-instance/war/index.md',
-                                items: [
-                                    {text: 'build', link: '/run-instance/war/build.md'},
-                                    {text: 'download', link: '/run-instance/war/download.md'},
-                                    {text: 'configure', link: '/run-instance/war/configure.md'},
-                                    {text: 'run', link: '/run-instance/war/run.md'},
-                                    {text: 'troubleshoot', link: '/run-instance/war/troubleshoot.md'}
-                                ]},
-                            {text: 'ORS as Docker Container (WAR)', collapsed: true, link: '/run-instance/war-docker/index.md',
-                                items: [
-                                    {text: 'build', link: '/run-instance/jar-docker/build.md'},
-                                    {text: 'download', link: '/run-instance/jar-docker/download.md'},
-                                    {text: 'configure', link: '/run-instance/jar-docker/configure.md'},
-                                    {text: 'run', link: '/run-instance/jar-docker/run.md'},
-                                    {text: 'troubleshoot', link: '/run-instance/jar-docker/troubleshoot.md'}
-                                ]},
-                                {text: 'Building from Source', link: '/run-instance/building-from-source'},                            {
-                            },
+                            {text: 'Running with Docker', link: '/run-instance/running-with-docker'},
+                            {text: 'Running JAR', link: '/run-instance/running-jar'},
+                            {text: 'Running WAR', link: '/run-instance/running-war'},
+                            {text: 'Building from Source', link: '/run-instance/building-from-source'},
                             {
                                 text: 'Configuration', collapsed: true, link: '/run-instance/configuration/',
                                 items: [

docs/getting-started.md

@@ -12,7 +12,7 @@ The fastest way to get to the info you are looking for is **the search bar above
 * [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
-  * [Installation](run-instance/installation/index.md) either directly using [JAR / WAR](run-instance/installation/running-jar-war) artifacts, with [Docker](run-instance/installation/running-with-docker) or [building from source](run-instance/building-from-source.md)
+  * [Installation](run-instance/installation/index.md) either directly using [JAR / WAR](run-instance/installation/running-jar-war) artifacts, with [Docker](run-instance/running-with-docker.md) or [building from source](run-instance/building-from-source.md)
   * [Configuration](run-instance/configuration/index.md) of openrouteservice instances
 * [Contributing](contributing/index.md) contains info about contributing to the openrouteservice, the OpenStreetMap and [translations](contributing/contributing-translations)
 * [Technical details](technical-details/index.md) contains all sorts of explanation about the internal workings of the openrouteservice.

docs/run-instance/building-from-source.md

@@ -5,19 +5,54 @@ If you need to customize your openrouteservice instance even further than what i
 ## Prerequisites
 
 The following documentation assumes you are running an Ubuntu 20.04 system (also generally works with newer Ubuntu versions). Depending on your environment, you might need to adjust certain details. You will also need to make sure to have the following installed: 
-* [git](https://github.com/git-guides/install-git) should be available on your system
-* [java](https://www.java.com/en/) 17 should be available, preferably as default Java environment
-* [maven](https://maven.apache.org/) should be installed on your system
+* [java](https://www.java.com/en/) 17 (or higher) should be available, preferably as default Java environment.
+* [maven](https://maven.apache.org/) should be installed on your system.
+* [git](https://github.com/git-guides/install-git) should be available on your system if you want to download the source code conveniently.
 
-## Get Source Code
+## Download source code
+
+If you have git installed, the easiest way to download the source code is to clone the repository with the following command:
 
-Clone and switch into the repository with the following commands:
 ```shell
-git clone https://github.com/user/openrouteservice.git
+git clone https://github.com/GIScience/openrouteservice.git
 cd openrouteservice
 ```
 
-## Running with maven
+This creates a directory named `openrouteservice` containing the downloaded source code. All following instructions will assume you are within that directory. 
+
+If you do not have git installed on your system, you can also download the packed (`.zip` and `.tar.gz`) source code file from the "Assets" section of the desired release from our github [releases](https://github.com/GIScience/openrouteservice/releases) page. Unpack the archive and run the following instructions within the directory you unpacked the source code into.
+
+## Build JAR 
+
+When your source code is set up, you can generate a runnable openrouteservice fat JAR:
+
+```shell
+mvn clean package -PbuildFatJar
+```
+
+Because JAR is the default, you can also run the command without `-PbuildFatJar`:
+
+```shell
+mvn clean package
+```
+
+You will find the fat JAR file in `ors-api/target/ors.jar`
+
+The chapter on [JAR](running-jar.md) artifact explains how to configure and run the JAR file.
+
+## Build WAR
+
+When your source code is set up, you can generate a deployable openrouteservice WAR:
+
+```shell
+mvn clean package -PbuildWar
+```
+
+You will find the WAR file in `ors-api/target/ors.war`
+
+The chapter on [WAR](running-war.md) artifact explains how to configure and deploy the WAR file.
+
+## Run source code directly
 
 You should be able to run the application directly with  
 
@@ -30,10 +65,15 @@ and a small OSM data set from Heidelberg.
 
 In [Configuration](configuration/index.md) you find the options how you can use customised configurations.  
 
-To create a deployable WAR or JAR artifact, please refer to the documentation for [JAR](jar/build.md) and [WAR](war/build.md).
+## For developers
+
+If you need to customize openrouteservice more 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/)! 
+
+The following instructions are useful to get you set up to start modifying the code.
 
+### Running from within IDE
 
-## Running from within IDE
+[//]: # (TODO: review below here)
 
 To run the project from within your IDE, you have to:
 
@@ -47,7 +87,7 @@ To run the project from within your IDE, you have to:
 7. You can run all tests via JUnit.
 
 
-## Running Tests
+### Running Tests
 
 Running tests is essential if you change the code. Please always make sure that all tests are passing. Failing test sometimes indicate, that code changes break existing code. If the expected behavior of the application changes, it might also be necessary to change existing tests. For new functionality, new tests should be added.
 
@@ -75,7 +115,7 @@ mvn clean package -DskipTests
 ```
 
 
-## Integrating GraphHopper
+### Integrating GraphHopper
 
 If you need to make adjustments to our forked and edited [GraphHopper repository](https://github.com/GIScience/graphhopper), follow these steps:
 

docs/run-instance/configuration/index.md

@@ -12,7 +12,7 @@ There are two (optional) ways for you to provide openrouteservice the location o
       export ORS_CONFIG_LOCATION=/path/to/ors-config.yml
       java -jar ors.jar
       ```
-If both is specified, the program argument wins. 
+If both are specified, the program argument wins. 
 
 [//]: # (TODO: test this)
 
@@ -35,10 +35,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/jar/configure.md),
-[WAR](/run-instance/war/configure.md) and 
-[Docker (JAR)](/run-instance/jar-docker/configure.md) / 
-[Docker (WAR)](/run-instance/war-docker/configure.md).
+[JAR](/run-instance/running-jar.md),
+[WAR](/run-instance/running-war.md) and 
+[Docker](/run-instance/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 a [example env file](https://github.com/GIScience/openrouteservice/blob/main/ors-config.env) that you can download and customize. 

docs/run-instance/data.md

@@ -1,4 +1,4 @@
-# Folders and Files
+# Data: Input and output folders and files
 
 ## Input Files
 
@@ -27,6 +27,11 @@ Data relating to the avoid borders features is derived from administrative bound
 
 Configuration parameters: [`ors.engine.profiles.*.ext_storages.Borders`](/run-instance/configuration/ors/engine/profiles.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`](/run-instance/configuration/ors/engine/profiles.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/)
@@ -42,7 +47,7 @@ Openrouteservice produces output files of three types, for which the paths can b
 
 openrouteservice reads the input data and computes a graph for each enabled routing profile. 
 
-The root directory for the graphs can be configured with the configuration property [`graphs_root_path`](/run-instance/configuration/ors/engine/index.md). 
+The root directory for the graphs can be configured with the configuration property [`ors.engine.graphs_root_path`](/run-instance/configuration/ors/engine/index.md). 
 
 ### Elevation Cache