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

fix: relative links in documentation #1791

Merged
merged 1 commit into from
May 13, 2024
Merged

fix: relative links in documentation #1791

merged 1 commit into from
May 13, 2024

Conversation

aoles
Copy link
Member

@aoles aoles commented May 13, 2024

Use consistently relative paths when linking to content from other files such that links are correctly resolved in both plain markdown and vitepress.

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 #1789.

Information about the changes

  • Key functionality added: switch to valid relative links.
  • Reason for change: enable correct links when navigating through markdown sources.

@github-actions github-actions bot added the fix label May 13, 2024
Use consistently relative paths when linking to content from other files such that links are correctly resolved in both plain markdown and vitepress.
@aoles aoles force-pushed the fix/links_in_docs branch from 4a0d765 to c60080b Compare May 13, 2024 14:03
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

@aoles aoles marked this pull request as ready for review May 13, 2024 14:20
@github-actions github-actions bot added fix and removed fix labels May 13, 2024
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

@jhaeu jhaeu merged commit ec0feed into main May 13, 2024
44 checks passed
@jhaeu jhaeu deleted the fix/links_in_docs branch May 13, 2024 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: Awaiting release
Development

Successfully merging this pull request may close these issues.

Dead link in docs
2 participants