Skip to content

fix(QTDI-512): documentation navigation #1091

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

ozhelezniak-talend
Copy link
Contributor

  • now we can navigate between versions to see the doc change with time

Requirements

  • Any code change adding any logic MUST be tested through a unit test executed with the default build
  • Any API addition MUST be done with a documentation update if relevant

Why this PR is needed?

What does this PR adds (design/code thoughts)?

* now we can navigate between versions to see the doc change with time
Copilot

This comment was marked as outdated.

* now we can navigate between versions to see the doc change with time
* now we can navigate between versions to see the doc change with time
* now we can navigate between versions to see the doc change with time
Copilot

This comment was marked as outdated.

* now we can navigate between versions to see the doc change with time
Copilot

This comment was marked as outdated.

* now we can navigate between versions to see the doc change with time
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes documentation navigation to enable version switching while preserving the current page context. Users can now navigate between different documentation versions and stay on the same page when possible.

  • Added custom Handlebars helpers to validate paths and swap URL segments for version navigation
  • Enhanced the header template to use intelligent URL construction for version links
  • Updated Antora version and registered new extensions for improved functionality

Reviewed Changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
header-content.hbs Modified version navigation to use intelligent URL swapping instead of direct links
swapLastSegment.js New helper function to extract and replace path segments for cross-version navigation
site-map.js New Antora extension providing path validation helper for template usage
site-template.yml Registered the new site-map extension for production builds
site-dev-template.yml Registered the new site-map extension for development builds
generated_actions.adoc Added entriesOrdered arrays to schema examples (likely auto-generated content)
pom.xml Updated Antora and Asciidoctor plugin versions

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.

* now we can navigate between versions to see the doc change with time
mhryb
mhryb previously approved these changes Aug 18, 2025
* now we can navigate between versions to see the doc change with time
Copy link

sonar-eks bot commented Aug 18, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants