Skip to content

Commit

Permalink
Update src location in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
optionsome committed Oct 15, 2024
1 parent ad69d38 commit afc5208
Show file tree
Hide file tree
Showing 12 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ generated during build and are not checked into the repository.
Use latest LTS version of Node/npm (currently v18). Recommend using a version manager such as `nvm`.

The dev and production builds require graphql schema to be present at
`../src/main/resources/org/opentripplanner/apis/transmodel/schema.graphql`.
`../application/src/main/resources/org/opentripplanner/apis/transmodel/schema.graphql`.

## Getting started (development)

Expand Down
2 changes: 1 addition & 1 deletion doc/templates/BuildConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ OTP allows you to adjust the elevation values reported in API responses in two w
is to store ellipsoid (GPS) elevation values internally, but apply a single geoid difference value
in the OTP client where appropriate to display elevations above sea level. This ellipsoid to geoid
difference is returned in each trip plan response in the
[ElevationMetadata](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/src/main/java/org/opentripplanner/api/resource/ElevationMetadata.java)
[ElevationMetadata](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/application/src/main/java/org/opentripplanner/api/resource/ElevationMetadata.java)
field. Using a single value can be sufficient for smaller OTP deployments, but might result in
incorrect values at the edges of larger OTP deployments. If your OTP instance uses this, it is
recommended to set a default request value in the `router-config.json` file as follows:
Expand Down
2 changes: 1 addition & 1 deletion doc/templates/GraphQL-Tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ Most people want to get routing results out of OTP, so lets see the query for th
Again, please use the autocomplete and documentation viewers to figure out what each input parameter
and property means.

More examples for a variety of queries can also be found [in the test code](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/src/test/resources/org/opentripplanner/apis/gtfs/queries).
More examples for a variety of queries can also be found [in the test code](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/application/src/test/resources/org/opentripplanner/apis/gtfs/queries).
2 changes: 1 addition & 1 deletion doc/templates/RouterConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ These options can be applied by the OTP server without rebuilding the graph.

Certain settings can be provided on the command line, when starting OpenTripPlanner. See
the `CommandLineParameters` class
for [a full list of arguments](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/src/main/java/org/opentripplanner/standalone/config/CommandLineParameters.java)
for [a full list of arguments](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/application/src/main/java/org/opentripplanner/standalone/config/CommandLineParameters.java)
.

## Routing defaults
Expand Down
2 changes: 1 addition & 1 deletion doc/user/BuildConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ OTP allows you to adjust the elevation values reported in API responses in two w
is to store ellipsoid (GPS) elevation values internally, but apply a single geoid difference value
in the OTP client where appropriate to display elevations above sea level. This ellipsoid to geoid
difference is returned in each trip plan response in the
[ElevationMetadata](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/src/main/java/org/opentripplanner/api/resource/ElevationMetadata.java)
[ElevationMetadata](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/application/src/main/java/org/opentripplanner/api/resource/ElevationMetadata.java)
field. Using a single value can be sufficient for smaller OTP deployments, but might result in
incorrect values at the edges of larger OTP deployments. If your OTP instance uses this, it is
recommended to set a default request value in the `router-config.json` file as follows:
Expand Down
4 changes: 2 additions & 2 deletions doc/user/Frontends.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ On the other hand, **production frontends** are intended to be a component of la
The main OpenTripPlanner repository currently contains two debug web frontends:

- new one currently under development at [`/client`](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/client).
- the classic one in [`/src/client/classic-debug/`](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/src/client/classic-debug)
- the classic one in [`/src/client/classic-debug/`](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/application/src/client/classic-debug)

The **new debug client** is a React/TypeScript Single Page App (SPA) that can be served locally or accessed over a content delivery network (CDN).
Unlike the original debug client, it connects to the OTP Java backend via the GraphQL API using the Transmodel vocabulary. By default, it is available at the root URL (`http://localhost:8080/` in local operation).
Expand All @@ -29,7 +29,7 @@ It connects to the OTP Java backend via a REST API using the GTFS vocabulary. Hi
It is still available, but has been moved to `http://localhost:8080/classic-debug/` .

There is a third piece of software that might qualify as an OTP client: a Java Swing application making use of the Processing visualization library,
located in the [GraphVisualizer class](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/src/main/java/org/opentripplanner/visualizer/GraphVisualizer.java).
located in the [GraphVisualizer class](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/application/src/main/java/org/opentripplanner/visualizer/GraphVisualizer.java).
While it would not be accurate to call this a "native" desktop application (as it's cross-platform Java) it is not a web app. This very developer-centric
UI is also over a decade old and has been very sparsely maintained, but continues to exist because it can visualize the progress of searches through the
street network, providing some insight into the internals of the routing algorithms that are not otherwise visible.
Expand Down
2 changes: 1 addition & 1 deletion doc/user/RouteRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -964,7 +964,7 @@ The defaults should work fine, but if you have results with short wait-times dom
option or "back-travel", then try to increase the `minSafeWaitTimeFactor`,
`backTravelWaitTimeFactor` and/or `extraStopBoardAlightCostsFactor`.

For details on the logic/design see [transfer optimization](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/src/main/java/org/opentripplanner/routing/algorithm/transferoptimization/package.md)
For details on the logic/design see [transfer optimization](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/application/src/main/java/org/opentripplanner/routing/algorithm/transferoptimization/package.md)
package documentation.


Expand Down
4 changes: 2 additions & 2 deletions doc/user/RouterConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ These options can be applied by the OTP server without rebuilding the graph.

Certain settings can be provided on the command line, when starting OpenTripPlanner. See
the `CommandLineParameters` class
for [a full list of arguments](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/src/main/java/org/opentripplanner/standalone/config/CommandLineParameters.java)
for [a full list of arguments](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/application/src/main/java/org/opentripplanner/standalone/config/CommandLineParameters.java)
.

## Routing defaults
Expand Down Expand Up @@ -355,7 +355,7 @@ The provided array of durations is used to increase the search-window for the ne
The search window is expanded when the current page return few options. If ZERO result is returned
the first duration in the list is used, if ONE result is returned then the second duration is used
and so on. The duration is added to the existing search-window and inserted into the next and
previous page cursor. See JavaDoc for [TransitTuningParameters#pagingSearchWindowAdjustments](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/src/main/java/org/opentripplanner/routing/algorithm/raptor/transit/TransitTuningParameters.java)" +
previous page cursor. See JavaDoc for [TransitTuningParameters#pagingSearchWindowAdjustments](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/application/src/main/java/org/opentripplanner/routing/algorithm/raptor/transit/TransitTuningParameters.java)" +
for more info."


Expand Down
2 changes: 1 addition & 1 deletion doc/user/Troubleshooting-Routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ props.setProperties("surface=mud", StreetTraversalPermission.ALL, 1.5, 1.5, true
```

The Javadoc
of [`OSMSpecifier.java`](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/src/main/java/org/opentripplanner/graph_builder/module/osm/OSMSpecifier.java)
of [`OSMSpecifier.java`](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/application/src/main/java/org/opentripplanner/graph_builder/module/osm/OSMSpecifier.java)
contains the precise documentation about the syntax of the matchers.

There are a lot of rules for which tags results in a specific safety score so it's not easy to get
Expand Down
2 changes: 1 addition & 1 deletion doc/user/apis/GraphQL-Tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,4 +138,4 @@ Most people want to get routing results out of OTP, so lets see the query for th
Again, please use the autocomplete and documentation viewers to figure out what each input parameter
and property means.

More examples for a variety of queries can also be found [in the test code](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/src/test/resources/org/opentripplanner/apis/gtfs/queries).
More examples for a variety of queries can also be found [in the test code](https://github.com/opentripplanner/OpenTripPlanner/tree/dev-2.x/application/src/test/resources/org/opentripplanner/apis/gtfs/queries).
2 changes: 1 addition & 1 deletion doc/user/sandbox/GoogleCloudStorage.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

To enable this turn on the feature `GoogleCloudStorage`. OTP can load or store artifacts from one or
more Google Cloud Storge locations. Each artifact must be configured in the _build-config.json_:
See [`BuildConfig`](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/src/main/java/org/opentripplanner/standalone/config/BuildConfig.java)
See [`BuildConfig`](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/application/src/main/java/org/opentripplanner/standalone/config/BuildConfig.java)
on how to configure artifacts.

Example (build-config.json):
Expand Down
2 changes: 1 addition & 1 deletion doc/user/sandbox/transferanalyzer.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ generates lists of both unusually long and unroutable transfers. These lists can
to improve the quality of OSM data for transfer purposes.

See javadoc in
[DirectTransferAnalyzer](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/src/ext/java/org/opentripplanner/ext/transferanalyzer/DirectTransferAnalyzer.java)
[DirectTransferAnalyzer](https://github.com/opentripplanner/OpenTripPlanner/blob/dev-2.x/application/src/ext/java/org/opentripplanner/ext/transferanalyzer/DirectTransferAnalyzer.java)
class

0 comments on commit afc5208

Please sign in to comment.