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: improvements to external storage documentation #1811

Merged
merged 5 commits into from
Sep 30, 2024

Conversation

aoles
Copy link
Member

@aoles aoles commented Jun 25, 2024

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)

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.

Looks good, I commented a few typos/formulation changes.

docs/api-reference/endpoints/directions/routing-options.md Outdated Show resolved Hide resolved
docs/run-instance/configuration/ors/engine/profiles.md Outdated Show resolved Hide resolved
docs/run-instance/configuration/ors/engine/profiles.md Outdated Show resolved Hide resolved
Copy link

sonarcloud bot commented Jul 3, 2024

@aoles
Copy link
Member Author

aoles commented Jul 25, 2024

It turned out tollways storage is not the only one which has not been covered in the docs. It needs to be double checked what is still missing and documented accordingly to finish-up this PR.

@aoles aoles force-pushed the docs/tollways_external_storage branch from e02244a to 3006b72 Compare September 27, 2024 07:41
@aoles aoles force-pushed the docs/tollways_external_storage branch from 3006b72 to 208729d Compare September 27, 2024 10:57
@aoles aoles marked this pull request as ready for review September 30, 2024 07:47
Copy link

sonarcloud bot commented Sep 30, 2024

@takb takb disabled auto-merge September 30, 2024 09:46
@takb takb enabled auto-merge September 30, 2024 09:46
@takb takb disabled auto-merge September 30, 2024 09:47
@takb takb merged commit 9093cce into main Sep 30, 2024
2 checks passed
@takb takb deleted the docs/tollways_external_storage branch September 30, 2024 09:48
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.

4 participants