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: rewrite docu for docker setup #1746

Merged
merged 33 commits into from
Mar 19, 2024
Merged

docs: rewrite docu for docker setup #1746

merged 33 commits into from
Mar 19, 2024

Conversation

jhaeu
Copy link
Contributor

@jhaeu jhaeu commented Mar 11, 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: New docu for new fatJar based docker image and docker-compose file
  • Reason for change: Documentation for docker setup was outdated (still docker setup with WAR+Tomcat)

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

Required changes to ors config (if applicable)

@jhaeu jhaeu requested a review from MichaelsJP March 11, 2024 14:51
@jhaeu jhaeu added this to the V8 Release milestone Mar 11, 2024
@jhaeu jhaeu marked this pull request as draft March 11, 2024 14:52
@jhaeu jhaeu marked this pull request as ready for review March 12, 2024 12:39
@jhaeu jhaeu requested a review from koebi March 12, 2024 12:39
Copy link
Member

@MichaelsJP MichaelsJP left a comment

Choose a reason for hiding this comment

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

Intermediate review. Not yet through.

docs/run-instance/running-with-docker.md Outdated Show resolved Hide resolved
docs/run-instance/running-with-docker.md Outdated Show resolved Hide resolved
docs/run-instance/running-with-docker.md Outdated Show resolved Hide resolved
docs/run-instance/running-with-docker.md Show resolved Hide resolved
docs/run-instance/running-with-docker.md Show resolved Hide resolved
docs/run-instance/running-with-docker.md Outdated Show resolved Hide resolved
@jhaeu jhaeu self-assigned this Mar 14, 2024
@MichaelsJP
Copy link
Member

We should also adapt the installation part in the Readme.md.

@jhaeu jhaeu force-pushed the docs/fat-jar-docker-docu branch from 0cec499 to 13670b8 Compare March 14, 2024 13:57
@MichaelsJP MichaelsJP self-requested a review March 15, 2024 00:11
Copy link
Member

@MichaelsJP MichaelsJP left a comment

Choose a reason for hiding this comment

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

LGTM, but someone else from the team should definitely look over it as well!

One thing, please add a changelog entry still before merging.

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.

Can you point me to the workflow that takes care of the release assets?

Also, we should add an overview of the existing official docker images and link it from the README.

docs/run-instance/running-with-docker.md Outdated Show resolved Hide resolved
docs/run-instance/running-with-docker.md Show resolved Hide resolved
docs/run-instance/running-with-docker.md Outdated Show resolved Hide resolved
docs/run-instance/running-with-docker.md Outdated Show resolved Hide resolved
docs/run-instance/running-with-docker.md Outdated Show resolved Hide resolved
docs/run-instance/running-with-docker.md Outdated Show resolved Hide resolved
docs/run-instance/running-with-docker.md Outdated Show resolved Hide resolved
docs/run-instance/running-with-docker.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@MichaelsJP
Copy link
Member

MichaelsJP commented Mar 15, 2024

Can you point me to the workflow that takes care of the release assets?

@koebi Here you go

build_and_publish_release_artifacts:

This releases the docker image as well as uploading release artifacts.


This workflow takes care of setting the additional tags: vX and latest
https://github.com/GIScience/openrouteservice/blob/main/.github/workflows/release-tag-latest.yml

@jhaeu jhaeu force-pushed the docs/fat-jar-docker-docu branch from a5c1288 to 613bdd0 Compare March 18, 2024 09:51
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
jhaeu and others added 12 commits March 19, 2024 10:39
Co-authored-by: Jakob Schnell <Jakob.Schnell@heigit.org>
Co-authored-by: Jakob Schnell <Jakob.Schnell@heigit.org>
Co-authored-by: Jakob Schnell <Jakob.Schnell@heigit.org>
Co-authored-by: Jakob Schnell <Jakob.Schnell@heigit.org>
Co-authored-by: Jakob Schnell <Jakob.Schnell@heigit.org>
Co-authored-by: Jakob Schnell <Jakob.Schnell@heigit.org>
Co-authored-by: Jakob Schnell <Jakob.Schnell@heigit.org>
Co-authored-by: Jakob Schnell <Jakob.Schnell@heigit.org>
Co-authored-by: Jakob Schnell <Jakob.Schnell@heigit.org>
Co-authored-by: Jakob Schnell <Jakob.Schnell@heigit.org>
@jhaeu jhaeu force-pushed the docs/fat-jar-docker-docu branch from 52e1814 to 6eb0706 Compare March 19, 2024 09:41
Copy link
Contributor

@TheGreatRefrigerator TheGreatRefrigerator left a comment

Choose a reason for hiding this comment

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

OK

@jhaeu jhaeu enabled auto-merge March 19, 2024 12:31
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.

Two minor notes, otherwise it looks good to me :)

README.md Outdated Show resolved Hide resolved
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@jhaeu jhaeu merged commit b089736 into main Mar 19, 2024
29 checks passed
@jhaeu jhaeu deleted the docs/fat-jar-docker-docu branch March 19, 2024 13:33
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