fix(layouts): use File.Dir for baseURL-independent product detection #6664
Conversation
This file contains hidden or 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
Create centralized product-info.html partial that extracts product/version from .File.Dir instead of .RelPermalink. This ensures product detection works correctly regardless of baseURL configuration, including PR preview deployments at subdirectory paths. Updated shortcodes: - api-endpoint.html - influxdb/host.html - children.html
jstirnaman
added
hold off
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.
Summary
Architectural fix for product detection in shortcodes - uses
.File.Dirinstead of.RelPermalinkto make product detection independent of baseURL configuration.Problem
Shortcodes parse
.RelPermalinkto determine product context, but whenbaseURLincludes a path (e.g., for PR previews at/docs-v2/pr-preview/pr-XXXX/), the path segments shift and product detection fails.Solution
Creates a centralized
product-info.htmlpartial that extracts product/version from.File.Dir(the content file's directory path), which is unaffected by baseURL configuration.Changes
layouts/partials/product-info.html- New partial for baseURL-independent product detectionlayouts/shortcodes/api-endpoint.html- Uses new partiallayouts/shortcodes/influxdb/host.html- Uses new partiallayouts/shortcodes/children.html- Uses new partialBenefits
Test plan
.RelPermalinkfor product detectionNote: This is the broader architectural fix for later testing. A localized workaround for PR previews is in the
ci-pr-previewbranch.