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

feat: docs versioning #1919

Merged
merged 28 commits into from
Dec 11, 2024
Merged

feat: docs versioning #1919

merged 28 commits into from
Dec 11, 2024

Conversation

koebi
Copy link
Collaborator

@koebi koebi commented Nov 29, 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)

@koebi koebi marked this pull request as ready for review December 6, 2024 14:41
@TheGreatRefrigerator
Copy link
Contributor

search within versions can't be realized with the render function:
https://github.com/vuejs/vitepress/blob/ff254dcbe6f2bcc89c34d2d2f4050229dc094400/src/node/plugins/localSearchPlugin.ts#L4
there is an example for mutiple locales, but for each of them a separate index is generated which would be the way to go.
But i would say, as the versions plugin maintainer said, VitePress should implement proper versioning support that include this. So for now stay at only latest version searchable. Maybe there is a way to disable the search on older versions?

@TheGreatRefrigerator TheGreatRefrigerator changed the title Docs versioning feat: docs versioning Dec 10, 2024
koebi and others added 26 commits December 10, 2024 14:44
and update vitepress, while we're at it.
Adds [] around the sidebar config
Due to bugs in vitepress-versioning-plugin, the versioned sidebars only
render if locales are enabled in the config.

Furthermore, we need the fixed version of the plugin until it is
officially fixed and available via npm.
The VersionSwitcher component does not seem to show the current version
correctly, so we go back to the default.

This reverts commit b5632f5.
@TheGreatRefrigerator
Copy link
Contributor

rebased on main

Copy link

sonarcloud bot commented Dec 10, 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 083adbc into main Dec 11, 2024
27 checks passed
@jhaeu jhaeu deleted the docs-versioning branch December 11, 2024 09:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants