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: add recommended setup method #1585

Merged
merged 6 commits into from
Oct 27, 2023
Merged

Conversation

MichaelsJP
Copy link
Member

Master/Nightly should only be used if users know what they do. Everyone else should always use the latest or a specific version.

Pull Request Checklist

  • 1. I have rebased the latest version of the master 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)

koebi
koebi previously requested changes Oct 27, 2023
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.

LGTM, I'd support using latest over nightly :)
Only issue is the two comments I gave.

docs/installation/Running-with-Docker.md Outdated Show resolved Hide resolved
docs/installation/Running-with-Docker.md Outdated Show resolved Hide resolved
@MichaelsJP MichaelsJP enabled auto-merge (squash) October 27, 2023 15:24
@MichaelsJP MichaelsJP requested a review from joker234 October 27, 2023 15:24
Copy link
Member

@joker234 joker234 left a comment

Choose a reason for hiding this comment

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

requested changes are done ✔

@joker234 joker234 requested a review from koebi October 27, 2023 15:25
@MichaelsJP MichaelsJP removed the request for review from koebi October 27, 2023 15:25
@MichaelsJP MichaelsJP self-assigned this Oct 27, 2023
@joker234 joker234 dismissed koebi’s stale review October 27, 2023 15:26

done, see other approval

@MichaelsJP MichaelsJP disabled auto-merge October 27, 2023 15:27
@MichaelsJP MichaelsJP force-pushed the docs/recommended-setup branch from d8eacec to 08a607b Compare October 27, 2023 15:52
@MichaelsJP MichaelsJP enabled auto-merge (squash) October 27, 2023 15:53
@MichaelsJP MichaelsJP disabled auto-merge October 27, 2023 15:58
@MichaelsJP MichaelsJP enabled auto-merge (squash) October 27, 2023 15:59
MichaelsJP and others added 6 commits October 27, 2023 18:05
Master/Nightly should only be used if users know what they do.
Everyone else should always use the latest or a specific version.
@MichaelsJP MichaelsJP force-pushed the docs/recommended-setup branch from 08a607b to 1500d2c Compare October 27, 2023 16:05
@MichaelsJP MichaelsJP merged commit e6c3d63 into master Oct 27, 2023
9 of 10 checks passed
@MichaelsJP MichaelsJP deleted the docs/recommended-setup branch October 27, 2023 16:20
selimguvenc pushed a commit to selimguvenc/openrouteservice that referenced this pull request Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Awaiting release
Development

Successfully merging this pull request may close these issues.

3 participants