Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix jar and src location in docs and client codegen #6161

Merged
merged 5 commits into from
Oct 17, 2024
Merged

Fix jar and src location in docs and client codegen #6161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6cb05b1
Minor fixes to docs
optionsome Oct 15, 2024
ad69d38
Remove legacy localization docs
optionsome Oct 15, 2024
afc5208
Update src location in docs
optionsome Oct 15, 2024
d8bd5f5
Update schema location in client codegen
optionsome Oct 15, 2024
243c232
Minor fixes
optionsome Oct 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,10 @@ We run a speed test (included in the code) to measure the performance for every

## Repository layout

The main Java server code is in `src/main/`. OTP also includes a Javascript client based on the
Leaflet mapping library in `src/client/`. This client is now primarily used for testing, with most
major deployments building custom clients from reusable components. The Maven build produces a
unified ("shaded") JAR file at `target/otp-VERSION.jar` containing all necessary code and
dependencies to run OpenTripPlanner.
The main Java server code is in `application/src/main/`. OTP also includes a Javascript client based on the
MapLibre mapping library in `client/src/`. This client is now used for testing, with most major
deployments building custom clients from reusable components. The Maven build produces a unified ("shaded")
JAR file at `application/target/otp-VERSION.jar` containing all necessary code and dependencies to run OpenTripPlanner.

Additional information and instructions are available in
the [main documentation](http://docs.opentripplanner.org/en/dev-2.x/), including a
Expand Down
2 changes: 1 addition & 1 deletion client/README.md
View file
Open in desktop
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 client/codegen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { CodegenConfig } from '@graphql-codegen/cli';

const config: CodegenConfig = {
overwrite: true,
schema: '../src/main/resources/org/opentripplanner/apis/transmodel/schema.graphql',
schema: '../application/src/main/resources/org/opentripplanner/apis/transmodel/schema.graphql',
documents: 'src/**/*.{ts,tsx}',
generates: {
'src/gql/': {
Expand Down
2 changes: 1 addition & 1 deletion doc/templates/BuildConfiguration.md
View file
Open in desktop
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/ext/java/org/opentripplanner/ext/restapi/model/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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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/ext/java/org/opentripplanner/ext/restapi/model/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
View file
Open in desktop
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 [`/application/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
14 changes: 7 additions & 7 deletions doc/user/Getting-OTP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ OTP. If all goes well you should see a success message like the following:
[INFO] ------------------------------------------------------------------------
```

This build process should produce a JAR file called `otp-x.y.z-shaded.jar` in the `target/`
directory which contains all the compiled OTP classes and their dependencies (the external libraries
they use). The shell script called 'otp' in the root of the cloned repository will start the main
class of that JAR file under a Java virtual machine, so after the Maven build completes you should
be able to run `./otp --help` and see an OTP help message including command line options. Due to the
way Maven works, this script is not executable by default, so you will need to do `chmod u+x ./otp`
before you run it to mark it as executable.
This build process should produce a JAR file called `otp-x.y.z-shaded.jar` in the
`application/target/` directory which contains all the compiled OTP classes and their dependencies
(the external libraries they use). The shell script called 'otp' in the root of the cloned repository
will start the main class of that JAR file under a Java virtual machine, so after the Maven build
completes you should be able to run `./otp --help` and see an OTP help message including command line
options. Due to the way Maven works, this script is not executable by default, so you will need to do
`chmod u+x ./otp` before you run it to mark it as executable.
Comment on lines +69 to +73
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shell script doesn't exist any more but that's beyond the scope of this PR.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does exist (along side with a couple of others), @t2gran moved them to script directory.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But as stated in #6161 (comment), there are a few issues with the scripts as far as I can tell.


The words "clean package" are the build steps you want to run. You're telling maven to clean up any
extraneous junk in the directory, then perform all the build steps, including compilation, up to and
Expand Down
Loading
Loading