diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 91292d1e0f..c203106515 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -36,6 +36,6 @@ Fixes # . ### Required changes to ors config (if applicable) - -[config]: https://GIScience.github.io/openrouteservice/installation/Configuration.html +[config]: https://GIScience.github.io/openrouteservice/run-instance/configuration/ [api]: https://gitlab.gistools.geog.uni-heidelberg.de/giscience/openrouteservice-infrastructure/ors-docs-api#test-new-ors-documentation [rebase]: https://github.com/GIScience/openrouteservice/blob/main/CONTRIBUTE.md#pull-request-guidelines diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index 15320dc43d..ed5e067999 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -52,7 +52,7 @@ Be extra careful using `rebase` commands when collaborating on a branch with oth ### Contributing code -For a short explanation on how to set up, deploy and test **openrouteservice** locally for development, see our [installation instructions](https://GIScience.github.io/openrouteservice/installation/Building-from-Source). +For a short explanation on how to set up, deploy and test **openrouteservice** locally for development, see our [installation instructions](https://GIScience.github.io/openrouteservice/run-instance/installation/building-from-source). Though there are no concrete rules for code that is contributed, we have a few general styles that should be adopted: diff --git a/README.md b/README.md index 6a0aa499c7..763f7b0752 100644 --- a/README.md +++ b/README.md @@ -59,9 +59,9 @@ sed -i='' "s/openrouteservice\/openrouteservice:latest/openrouteservice\/openrou docker compose up -d ``` -For more details, check the [docker installation guide](https://GIScience.github.io/openrouteservice/installation/Running-with-Docker.html). +For more details, check the [docker installation guide](https://giscience.github.io/openrouteservice/run-instance/installation/running-with-docker). -For instructions on how to [build from source](https://GIScience.github.io/openrouteservice/installation/Building-from-Source.html) or [configure](https://GIScience.github.io/openrouteservice/installation/Configuration.html), visit our [Installation and Usage Instructions](https://GIScience.github.io/openrouteservice/installation/Installation-and-Usage.html). +For instructions on how to [build from source](https://giscience.github.io/openrouteservice/run-instance/installation/building-from-source) or [configure](https://giscience.github.io/openrouteservice/openrouteservice/run-instance/configuration/), visit our [Installation Instructions](https://giscience.github.io/openrouteservice/openrouteservice/run-instance/installation/). ## Usage @@ -71,7 +71,7 @@ Openrouteservice offers a set of endpoints for different spatial purposes. By de - `http://localhost:8080/ors/v2/isochrones` - `http://localhost:8080/ors/v2/matrix` -You can find more information in the [Installation and Usage Instructions](https://GIScience.github.io/openrouteservice/installation/Installation-and-Usage.html). +You can find more information in the [Installation Instructions](https://giscience.github.io/openrouteservice/run-instance/installation/running-with-docker). ## API Documentation @@ -85,4 +85,4 @@ For questions please use our [community forum](https://ask.openrouteservice.org) ## Translations -If you notice anything wrong with translations, or you want to add a new language to the ORS instructions, we have some instructions in our [backend documentation](https://GIScience.github.io/openrouteservice/contributing/Contributing-Translations) about how you can submit an update. You can also look over at our [maps client GitHub](https://github.com/GIScience/ors-map-client/#add-language) if you want to contribute the language to there as well (adding or editing the language in the openrouteservice GitHub repo only affects the instructions - any new language also needs adding to the client). +If you notice anything wrong with translations, or you want to add a new language to the ORS instructions, we have some instructions in our [backend documentation](https://GIScience.github.io/openrouteservice/contributing/contributing-translations) about how you can submit an update. You can also look over at our [maps client GitHub](https://github.com/GIScience/ors-map-client/#add-language) if you want to contribute the language to there as well (adding or editing the language in the openrouteservice GitHub repo only affects the instructions - any new language also needs adding to the client). diff --git a/ors-api/src/main/java/org/heigit/ors/api/controllers/RoutingAPI.java b/ors-api/src/main/java/org/heigit/ors/api/controllers/RoutingAPI.java index e7aaee9ec0..9c402e5b0a 100644 --- a/ors-api/src/main/java/org/heigit/ors/api/controllers/RoutingAPI.java +++ b/ors-api/src/main/java/org/heigit/ors/api/controllers/RoutingAPI.java @@ -101,7 +101,7 @@ public void getInvalidResponseType() throws StatusCodeException { """, summary = "Directions Service") @ApiResponse( responseCode = "200", - description = "Standard response for successfully processed requests. Returns GeoJSON. The decoded values of the extra information can be found [here](https://GIScience.github.io/openrouteservice/documentation/extra-info/Extra-Info.html).", + description = "Standard response for successfully processed requests. Returns GeoJSON. The decoded values of the extra information can be found [here](https://giscience.github.io/openrouteservice/api-reference/endpoints/directions/extra-info/).", content = {@Content( mediaType = "application/geo+json", schema = @Schema(implementation = GeoJSONRouteResponse.class) @@ -125,7 +125,7 @@ public GeoJSONRouteResponse getSimpleGeoJsonRoute(@Parameter(description = "Spec ) @ApiResponse( responseCode = "200", - description = "Standard response for successfully processed requests. Returns JSON. The decoded values of the extra information can be found [here](https://GIScience.github.io/openrouteservice/documentation/extra-info/Extra-Info.html).", + description = "Standard response for successfully processed requests. Returns JSON. The decoded values of the extra information can be found [here](https://giscience.github.io/openrouteservice/api-reference/endpoints/directions/extra-info/).", content = {@Content( mediaType = "application/json", schema = @Schema(implementation = JSONRouteResponse.class) @@ -191,7 +191,7 @@ public GPXRouteResponse getGPXRoute( ) @ApiResponse( responseCode = "200", - description = "Standard response for successfully processed requests. Returns GeoJSON. The decoded values of the extra information can be found [here](https://GIScience.github.io/openrouteservice/documentation/extra-info/Extra-Info.html).", + description = "Standard response for successfully processed requests. Returns GeoJSON. The decoded values of the extra information can be found [here](https://giscience.github.io/openrouteservice/api-reference/endpoints/directions/extra-info/).", content = {@Content( mediaType = "application/geo+json", schema = @Schema(implementation = GeoJSONRouteResponse.class) diff --git a/ors-api/src/main/java/org/heigit/ors/api/requests/common/RequestOptions.java b/ors-api/src/main/java/org/heigit/ors/api/requests/common/RequestOptions.java index 60505ffc80..a7f8e57105 100644 --- a/ors-api/src/main/java/org/heigit/ors/api/requests/common/RequestOptions.java +++ b/ors-api/src/main/java/org/heigit/ors/api/requests/common/RequestOptions.java @@ -55,7 +55,7 @@ public class RequestOptions implements RouteRequestParameterNames { @Schema(name = PARAM_AVOID_COUNTRIES, description = """ List of countries to exclude from matrix with `driving-*` profiles. Can be used together with `'avoid_borders': 'controlled'`. \ - `[ 11, 193 ]` would exclude Austria and Switzerland. List of countries and application examples can be found [here](https://GIScience.github.io/openrouteservice/documentation/routing-options/Country-List.html). \ + `[ 11, 193 ]` would exclude Austria and Switzerland. List of countries and application examples can be found [here](https://giscience.github.io/openrouteservice/technical-details/country-list). \ Also, ISO standard country codes cna be used in place of the numerical ids, for example, DE or DEU for Germany. \ """, extensions = {@Extension(name = "validWhen", properties = { diff --git a/ors-api/src/main/java/org/heigit/ors/api/requests/matrix/MatrixRequest.java b/ors-api/src/main/java/org/heigit/ors/api/requests/matrix/MatrixRequest.java index 040168f3ee..db3dcbf4ba 100644 --- a/ors-api/src/main/java/org/heigit/ors/api/requests/matrix/MatrixRequest.java +++ b/ors-api/src/main/java/org/heigit/ors/api/requests/matrix/MatrixRequest.java @@ -107,7 +107,7 @@ public class MatrixRequest extends APIRequest { private boolean hasOptimized = false; @Schema(name = PARAM_OPTIONS, - description = "For advanced options formatted as json object. For structure refer to the [these examples](https://GIScience.github.io/openrouteservice/documentation/routing-options/Examples.html).", + description = "For advanced options formatted as json object. For structure refer to the [these examples](src/main/java/org/heigit/ors/api/requests/matrix/MatrixRequest.java).", example = "{\"avoid_borders\":\"controlled\"}", hidden = true) @JsonProperty(PARAM_OPTIONS) diff --git a/ors-api/src/main/java/org/heigit/ors/api/requests/routing/RouteRequest.java b/ors-api/src/main/java/org/heigit/ors/api/requests/routing/RouteRequest.java index bb56002dc5..28bce6c676 100644 --- a/ors-api/src/main/java/org/heigit/ors/api/requests/routing/RouteRequest.java +++ b/ors-api/src/main/java/org/heigit/ors/api/requests/routing/RouteRequest.java @@ -189,7 +189,7 @@ Specifies a list of pairs (bearings and deviations) to filter the segments of th private boolean hasUseContractionHierarchies = false; @Schema(name = PARAM_OPTIONS, - description = "For advanced options formatted as json object. For structure refer to the [these examples](https://GIScience.github.io/openrouteservice/documentation/routing-options/Examples.html).", + description = "For advanced options formatted as json object. For structure refer to the [these examples](https://giscience.github.io/openrouteservice/api-reference/endpoints/directions/routing-options#examples).", example = "{\"avoid_borders\":\"controlled\"}") @JsonProperty(PARAM_OPTIONS) private RouteRequestOptions routeOptions; diff --git a/ors-api/src/main/java/org/heigit/ors/api/responses/routing/json/JSONExtraSummary.java b/ors-api/src/main/java/org/heigit/ors/api/responses/routing/json/JSONExtraSummary.java index 356612a56d..135e972a34 100644 --- a/ors-api/src/main/java/org/heigit/ors/api/responses/routing/json/JSONExtraSummary.java +++ b/ors-api/src/main/java/org/heigit/ors/api/responses/routing/json/JSONExtraSummary.java @@ -30,7 +30,7 @@ public JSONExtraSummary(double value, double distance, double amount) { this.amount = amount; } - @Schema(description = "[Value](https://GIScience.github.io/openrouteservice/documentation/extra-info/Extra-Info.html) of a info category.", example = "5") + @Schema(description = "[Value](https://giscience.github.io/openrouteservice/api-reference/endpoints/directions/extra-info/) of a info category.", example = "5") @JsonProperty("value") public double getValue() { return value; diff --git a/ors-api/src/main/java/org/heigit/ors/api/responses/routing/json/JSONStep.java b/ors-api/src/main/java/org/heigit/ors/api/responses/routing/json/JSONStep.java index ff1561c3a1..1ae519fc43 100644 --- a/ors-api/src/main/java/org/heigit/ors/api/responses/routing/json/JSONStep.java +++ b/ors-api/src/main/java/org/heigit/ors/api/responses/routing/json/JSONStep.java @@ -37,7 +37,7 @@ public class JSONStep { @JsonProperty("duration") @JsonFormat(shape = JsonFormat.Shape.NUMBER_FLOAT, pattern = "%.1d") private final Double duration; - @Schema(description = "The [instruction](https://GIScience.github.io/openrouteservice/documentation/Instruction-Types.html) action for symbolisation purposes.", example = "1") + @Schema(description = "The [instruction](https://giscience.github.io/openrouteservice/api-reference/endpoints/directions/instruction-types) action for symbolisation purposes.", example = "1") @JsonProperty("type") private final Integer type; @Schema(description = "The routing instruction text for the step.", example = "Turn right onto Berliner Straße")