docs: documentation overhaul #1651
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MichaelsJP
requested changes
Jan 19, 2024
ors-engine/src/main/java/org/heigit/ors/routing/configuration/RouteProfileConfiguration.java
Outdated
Show resolved
Hide resolved
ors-engine/src/main/java/org/heigit/ors/routing/graphhopper/extensions/ORSGraphHopper.java
Outdated
Show resolved
Hide resolved
koebi
requested changes
Jan 24, 2024
There was a problem hiding this comment.
Hey,
great work so far! This is definitely moving in the right direction, and I do like the structure you came up with :)
Is there a spell checker that we can run on this easily/automatedly? Haven't seen any major typos, but might be worth setting this up.
I have only skimmed the installation part in regards to the content.
Do we have an explanation of CH/LM/Core anywhere, or can we maybe link to some article(s)?
Is the order in which config options are read (ENV > ORS_CONFIG > appl.yml) documented?
There's an overarching issue in a few places:
The language 'jsonpath' is not loaded, falling back to 'txt' for syntax highlighting.
Are the values of the track- and waytype speed tables aligned with the speed value files?
Do we link to the documentation from github? Do we link to it from openrouteservice.org or from the API playground?
aoles
previously requested changes
Jan 24, 2024
Hydeo
reviewed
Jan 30, 2024
MichaelsJP
previously requested changes
Jan 31, 2024
docs/api-reference/endpoints/directions/extra-info/road-access-restrictions.md
Outdated
Show resolved
Hide resolved
docs/api-reference/endpoints/directions/requests-and-return-types.md
Outdated
Show resolved
Hide resolved
TheGreatRefrigerator
requested changes
Feb 5, 2024
ors-engine/src/main/java/org/heigit/ors/routing/graphhopper/extensions/ORSGraphHopper.java
Outdated
Show resolved
Hide resolved
|
@koebi should we exclude the deprecated JSON config from search? As it shows up a lot for configuration parameter searches.. |
aoles
force-pushed
the
docs/documentation-overhaul
branch
from
2d23f2c to
d58b609
Compare
TheGreatRefrigerator
force-pushed
the
docs/documentation-overhaul
branch
from
d58b609 to
63614f1
Compare
Supposedly this should fix said warnings according to vuejs/vitepress#3259, though locally it didn't seem to help. Need to investigate further when we have time.
Co-authored-by: Jakob Schnell <[email protected]> Co-authored-by: sfendrich <[email protected]> Co-authored-by: Takara Baumbach <[email protected]> Co-authored-by: Jochen Haeussler <[email protected]> Co-authored-by: Andrzej K. Oleś <[email protected]>
Co-authored-by: Jakob Schnell <[email protected]> Co-authored-by: sfendrich <[email protected]> Co-authored-by: Takara Baumbach <[email protected]> Co-authored-by: Jochen Haeussler <[email protected]> Co-authored-by: Andrzej K. Oleś <[email protected]>
TheGreatRefrigerator
force-pushed
the
docs/documentation-overhaul
branch
from
63614f1 to
3336135
Compare
TheGreatRefrigerator
requested review from
koebi,
aoles and
TheGreatRefrigerator
|
Restrucutred to 26 commits, with a few more fixed typos an the last adjustments to tag-filtering. |
TheGreatRefrigerator
approved these changes
Feb 13, 2024
- rework intro and add images - add entry for every endpoint - add warnings for endpoint availability - update & correct information - add general info on requests-and-return-types.md - include routing-options examples - remove unused Structured-Geocoding-Query.md Co-authored-by: Jakob Schnell <[email protected]> Co-authored-by: sfendrich <[email protected]> Co-authored-by: Takara Baumbach <[email protected]> Co-authored-by: Jochen Haeussler <[email protected]> Co-authored-by: Andrzej K. Oleś <[email protected]>
- update info & tables - add osm wiki link for osm way IDs - add info on shadow and csv - add jsonpath for where to find in response - add 'keep in sync' hints to code counterpart - add extra info response example Co-authored-by: Jakob Schnell <[email protected]> Co-authored-by: sfendrich <[email protected]> Co-authored-by: Takara Baumbach <[email protected]> Co-authored-by: Jochen Haeussler <[email protected]> Co-authored-by: Andrzej K. Oleś <[email protected]>
- move to dedicated yaml config documentation following application.yml structure - mark json config as deprecated - update and fix information, tables & links Co-authored-by: Jakob Schnell <[email protected]> Co-authored-by: sfendrich <[email protected]> Co-authored-by: Takara Baumbach <[email protected]> Co-authored-by: Jochen Haeussler <[email protected]> Co-authored-by: Andrzej K. Oleś <[email protected]>
- update, correct and restructure information - add dedicated running-jar-war.md file with draft for tomcat 10 - remove unused Advanced-Docker-Setup.md Co-authored-by: Jakob Schnell <[email protected]> Co-authored-by: sfendrich <[email protected]> Co-authored-by: Takara Baumbach <[email protected]> Co-authored-by: Jochen Haeussler <[email protected]> Co-authored-by: Andrzej K. Oleś <[email protected]>
- add index.md with general info and links - fix some infos & links - remove emojis from headings Co-authored-by: Jakob Schnell <[email protected]> Co-authored-by: sfendrich <[email protected]> Co-authored-by: Takara Baumbach <[email protected]> Co-authored-by: Jochen Haeussler <[email protected]> Co-authored-by: Andrzej K. Oleś <[email protected]>
Co-authored-by: Jakob Schnell <[email protected]> Co-authored-by: sfendrich <[email protected]> Co-authored-by: Amandus Butzer <[email protected]> Co-authored-by: Jochen Haeussler <[email protected]> Co-authored-by: Andrzej K. Oleś <[email protected]>
it has better visualisation Co-authored-by: Jakob Schnell <[email protected]>
- remove url encoding part, which is not needed for passing options in POST request - link vehicle_type to tag filtering - remove routing restriction option 'gradient' as support was removed - use jsonpath for options parameter headings docs(routing-options): adjust examples - check for validity and fix - remove pretty code block if minified is readable - make minified examples code blocks for quick copy Co-authored-by: Amandus <[email protected]>
- add info for conditional access restrictions - introduce default case per profile - remove false info of ways being always rejected Co-authored-by: Andrzej K. Oleś <[email protected]>
- remove double horizontal line
- add some header reference to links Note: Intellij still doesn't resolve dashed header references properly
TheGreatRefrigerator
force-pushed
the
docs/documentation-overhaul
branch
from
067517b to
921e6be
Compare
TheGreatRefrigerator
dismissed stale reviews from MichaelsJP and aoles
outdated
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Information about the changes
Reason for change: