Load mdx images from UDR #2684
Merged
Load mdx images from UDR #2684
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📦 Next.js Bundle AnalysisThis analysis was generated by the next.js bundle analysis action 🤖 This PR introduced no changes to the javascript bundle 🙌 |
RubenSandwich
commented
Feb 7, 2025
| @@ -273,6 +273,7 @@ describe('RemoteContentLoader', () => { | |||
| }) | |||
|
|
|||
| expect(mockMdxContentHook).toHaveBeenCalledWith(expect.any(String), { | |||
| product: 'waypoint', | |||
There was a problem hiding this comment.
Needed as we are now injecting the product into the "content loaders"
RubenSandwich
commented
Feb 7, 2025
| @@ -78,6 +78,9 @@ export function getDeployPreviewLoader({ | |||
| if ( | |||
| currentRootDocsPath.productSlugForLoader?.match( | |||
| /^(terraform|ptfe-releases)/i | |||
| ) && | |||
| !__config.flags?.unified_docs_migrated_repos?.find( | |||
There was a problem hiding this comment.
Added to prevent remark-rewrite-assets from running twice for terraform products
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.
🔗 Relevant links
🗒️ What
This PR modifies MDX image loading to load from the UDR asset API. It does this by updating and injecting the
remark-rewrite-assets.tsremark plugin to rewrite the MDX img URLs when an product is inconfig.flags.unified_docs_migrated_repos. Which currently only theHASHI_ENV=unified-docs-sandboxhas those flags set.Before this only use case of remark-rewrite-assets remark plugin was in rewriting the MDX imgs of URLS for any
terraformandptfe-releasesproducts. (e.g.terraform-plugins-*would match) So an added guard has been placed on that to make sure thatremark-rewrite-assetsdoes not run twice in those situations.🧪 Testing
This branch has special env vars injected into it so that it loads content from UDR. So it can be tested by visiting the following links:
A UDR product loads images from the UDR asset API
A NON UDR product loads images from the normal asset API
/_next/image?url=https%3A%2F%2Fcontent.hashicorp.com%2Fapi%2Fassets%3Fproduct%3Dnomad%26version%3Drefs%252Fheads%252Fstable-website%26asset%3Dwebsite%252Fpublic%252Fimg%252Fnomad-architecture-region.png%26width%3D1920%26height%3D852&w=3840&q=75&dpl=dpl_8W7uyq4JfqA3fDjL1z9LF9hFo1FA