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.

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

docs(setup): First draft for the tomcat 10, war setup example. #1920

Merged
merged 17 commits into from
Dec 11, 2024

Conversation

MichaelsJP
Copy link
Member

Pull Request Checklist

  • 1. I have rebased the latest version of the main branch into my feature branch and all conflicts
    have been resolved.
  • 2. I have added information about the change/addition to functionality to the CHANGELOG.md file under the
    [Unreleased] heading.
  • 3. I have documented my code using JDocs tags.
  • 4. I have removed unnecessary commented out code, imports and System.out.println statements.
  • 5. I have written JUnit tests for any new methods/classes and ensured that they pass.
  • 6. I have created API tests for any new functionality exposed to the API.
  • 7. If changes/additions are made to the ors-config.json file, I have added these to the ors config documentation
    along with a short description of what it is for, and documented this in the Pull Request (below).
  • 8. I have built graphs with my code of the Heidelberg.osm.gz file and run the api-tests with all test passing
  • 9. I have referenced the Issue Number in the Pull Request (if the changes were from an issue).
  • 10. For new features or changes involving building of graphs, I have tested on a larger dataset
    (at least Germany), and the graphs build without problems (i.e. no out-of-memory errors).
  • 11. For new features or changes involving the graphbuilding process (i.e. changing encoders, updating the
    importer etc.), I have generated longer distance routes for the affected profiles with different options
    (avoid features, max weight etc.) and compared these with the routes of the same parameters and start/end
    points generated from the current live ORS.
    If there are differences then the reasoning for these MUST be documented in the pull request.
  • 12. I have written in the Pull Request information about the changes made including their intended usage
    and why the change was needed.
  • 13. For changes touching the API documentation, I have tested that the API playground renders correctly.

Fixes # .

Information about the changes

  • Key functionality added:
  • Reason for change:

Examples and reasons for differences between live ORS routes, and those generated from this pull request

Required changes to ors config (if applicable)

@MichaelsJP MichaelsJP force-pushed the docs/tomcat-setup-example branch 2 times, most recently from 2f0d6c8 to 4c308fb Compare December 2, 2024 17:12
@MichaelsJP MichaelsJP marked this pull request as ready for review December 2, 2024 17:12
@MichaelsJP MichaelsJP requested review from aoles and jhaeu December 3, 2024 11:45
@MichaelsJP MichaelsJP requested a review from koebi December 3, 2024 11:49
Copy link
Contributor

@jhaeu jhaeu left a comment

Choose a reason for hiding this comment

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

Very nice documentation! I checked the equality of both languages and the links and made small suggestions. Everything is very plausible to me and fits the setup we were recently setting up twice, as far as I remember. I did not try the steps again within this review - but I assume you checked this...?

@aoles aoles force-pushed the docs/tomcat-setup-example branch from fd22fda to 22e9dd4 Compare December 9, 2024 08:48
Copy link
Collaborator

@koebi koebi left a comment

Choose a reason for hiding this comment

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

This is an explanation for v8.2.0 - as such, it should live there, as soon as versioning is merged.
The config shouldn't be touched, except where it adds the new files.

Once comments from the english version are introduced, they have to be synced to the german version as well.

@aoles
Copy link
Member

aoles commented Dec 9, 2024

@koebi Thanks for your detailed review and for checking the instructions 👍

I've reverted the changes to formatting of config.js in 8c6eb0d and applied the suggested changes to the German version as well via ef9e267.

Copy link
Contributor

@jhaeu jhaeu left a comment

Choose a reason for hiding this comment

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

LGTM

@koebi koebi force-pushed the docs/tomcat-setup-example branch from f080b42 to 2613540 Compare December 11, 2024 10:26
@koebi koebi merged commit f32dea8 into main Dec 11, 2024
6 of 7 checks passed
@koebi koebi deleted the docs/tomcat-setup-example branch December 11, 2024 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants