Skip to content

Commit

Permalink
docs: fix dead links (#1712)
Browse files Browse the repository at this point in the history
  • Loading branch information
TheGreatRefrigerator authored Mar 5, 2024
2 parents a890ad2 + 8866963 commit 1a354f4
Show file tree
Hide file tree
Showing 12 changed files with 26 additions and 24 deletions.
1 change: 0 additions & 1 deletion docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,6 @@ export default defineConfig({
{
text: 'Contributing', collapsed: true, link: '/contributing/',
items: [
{text: 'Opening project in IntelliJ', link: '/contributing/opening-project-in-intellij'},
{text: 'Backend documentation', link: '/contributing/backend-documentation'},
{text: 'Contribution guidelines', link: 'https://github.com/GIScience/openrouteservice/blob/main/CONTRIBUTE.md'},
{text: 'Contributing translations', link: '/contributing/contributing-translations'},
Expand Down
2 changes: 1 addition & 1 deletion docs/api-reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ 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/installation/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).

Expand Down
3 changes: 1 addition & 2 deletions docs/contributing/backend-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ npm run docs:dev
To build the static files to `docs/.vitepress/dist` and preview the production version locally, use

```bash
npm run docs:build
npm run docs:preview
npm run build-preview
```

::: info
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ can help with.

Feel free to create an [issue](https://github.com/GIScience/openrouteservice/issues) and label it accordingly.
If your issue regards the openrouteservice maps client on [maps.openrouteservice.org](https://maps.openrouteservice.org)
please use the [corresponding repository](https://github.com/GIScience/ors-maps-client/issues).
please use the [corresponding repository](https://github.com/GIScience/ors-map-client/issues).

## Contributing code

Expand Down
5 changes: 4 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ 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/running-with-docker.md) or [building from source](run-instance/building-from-source.md)
* [Running with Docker](run-instance/running-with-docker.md) artifact
* [Running JAR](run-instance/running-jar.md) artifact
* [Running WAR](run-instance/running-war.md) artifact
* [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.
Expand Down
8 changes: 4 additions & 4 deletions docs/run-instance/building-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ cd openrouteservice

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.
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

Expand Down Expand Up @@ -63,11 +63,11 @@ mvn spring-boot:run
or in your IDE (see below). This will start openrouteservice on port `8082` with the default configuration `ors-config.yml` in the project root directory
and a small OSM data set from Heidelberg.

In [Configuration](configuration/index.md) you find the options how you can use customised configurations.
In the [Configuration](configuration/index.md) section you find the options how you can use customised configurations.

## 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/)!
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/index.md)!

The following instructions are useful to get you set up to start modifying the code.

Expand All @@ -84,7 +84,7 @@ To run the project from within your IDE, you have to:
5. Finalize the project import by clicking "Finish" in the last window.
6. Configure your IDE to run `spring-boot:run` as the maven goal. Now you can run your application directly in IntelliJ.
7. To use a different config file than ors-config.yml in the project directory, you can set the environment variable `ORS_CONFIG_LOCATION=<config>` in your run config.
7. You can run all tests via JUnit.
8. You can run all tests via JUnit.


### Running Tests
Expand Down
5 changes: 3 additions & 2 deletions docs/run-instance/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Which format to use in which scenario is documented in the config documentations
[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.
* `.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.
* `.json` config file: In the past openrouteservice was configured [via JSON file](json.md). This configuration method has been **deprecated** and will be eventually removed. Therefore, we strongly discourage you from using it. If you have an old JSON config, please consider to [migrate to the new config](migrate-from-json.md).

All of the above described config files can contain the same logic application properties.
Expand Down Expand Up @@ -116,7 +116,8 @@ The options in order of precedence (higher options win over lower) are:
java -jar ors.jar
```

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/installation/running-with-docker.md).
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).

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`
Expand Down
10 changes: 5 additions & 5 deletions docs/run-instance/configuration/json.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,11 +279,11 @@ The top level element.

Array of message objects where each has

| key | type | description | example value |
|-----------|---------|-------------------------------------------------------------------|----------------------|
| active | boolean | Enables or disables this message | `true` |
| text | string | The message text | `"The message text"` |
| condition | object | omittable; may contain any of the conditions from the table below | |
| key | type | description | example value |
|-----------|---------|------------------------------------------------------------------|----------------------|
| active | boolean | Enables or disables this message | `true` |
| text | string | The message text | `"The message text"` |
| condition | object | optional; may contain any of the conditions from the table below | |

| condition | value | description |
|--------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
Expand Down
2 changes: 1 addition & 1 deletion docs/run-instance/configuration/ors/engine/profiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,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/#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
Expand Down
2 changes: 1 addition & 1 deletion docs/run-instance/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Input Files

The most important input file is the config file.
In [Configuration](/run-instance/configuration/index.md) you find everything about configuration options and files.
In the [Configuration](/run-instance/configuration/index.md) section you find everything about configuration options and files.

Openrouteservice makes use of public open-source data. To generate the best routes, a number of different datasets are used.

Expand Down
4 changes: 2 additions & 2 deletions docs/run-instance/running-jar.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To run openrouteservice, you also need an OSM data file, e.g. from [Geofabrik](h

## Download

Starting with version 8 you can download the ready to use JAR file from the "Assets" section of the desired release from our github [releases](https://github.com/GIScience/openrouteservice/releases) page.
Starting with version 8 you can download the ready to use JAR file from the "Assets" section of the desired release from our GitHub [releases](https://github.com/GIScience/openrouteservice/releases) page.

## Build

Expand All @@ -32,7 +32,7 @@ The recommended way to configure an openrouteservice instance run plain using th
wget https://raw.githubusercontent.com/GIScience/openrouteservice/main/ors-config.yml
```

For details on how to make openrouteservice apply the settings in the configuration file (there are multiple options) see chapter [Configuration](configuration/).
For details on how to make openrouteservice apply the settings in the configuration file (there are multiple options) see chapter [Configuration](configuration/index.md).

## Troubleshoot

Expand Down
6 changes: 3 additions & 3 deletions docs/run-instance/running-war.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Running openrouteservice as WAR

Like older versions, ORS version 8 can still be built and run as a Web Application Resource aka Web ARchive (WAR).
Like older versions, ORS version 8 can still be built and run as a Web Application Resource aka Web Archive (WAR).
A WAR file can be deployed to a Servlet Container like Tomcat, which is running as a service.
To run openrouteservice, you also need an OSM data file, e.g. from [Geofabrik](http://download.geofabrik.de). For more details see chapter [Data](data.md).

Expand All @@ -12,7 +12,7 @@ To run openrouteservice, you also need an OSM data file, e.g. from [Geofabrik](h

## Download

Starting with version 8 you can download the ready to use WAR from the "Assets" section of the desired release from our github [releases](https://github.com/GIScience/openrouteservice/releases) page.
Starting with version 8 you can download the ready to use WAR from the "Assets" section of the desired release from our GitHub [releases](https://github.com/GIScience/openrouteservice/releases) page.

## Build

Expand Down Expand Up @@ -41,7 +41,7 @@ Then you need to add an environment variable to your `setenv.sh` pointing to tha
ORS_CONFIG_LOCATION=/path/to/ors-config.yml
```

For details on how to make openrouteservice apply the settings in the configuration file (there are multiple options) see chapter [Configuration](configuration/).
For details on how to make openrouteservice apply the settings in the configuration file (there are multiple options) see chapter [Configuration](configuration/index.md).

## Troubleshoot

Expand Down

0 comments on commit 1a354f4

Please sign in to comment.