Skip to content

Commit

Permalink
fix: update links to docs in code (#1690)
Browse files Browse the repository at this point in the history
  • Loading branch information
TheGreatRefrigerator authored Feb 14, 2024
2 parents f2627d4 + f64cec3 commit 3c9f57f
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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).
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down

0 comments on commit 3c9f57f

Please sign in to comment.