fix: update internal links transform to run for all products #994
Conversation
Vercel Previews Deployed
|
LeahMarieBush
requested review from
Younique98,
RubenSandwich and
rmainwork
and removed request for
Younique98
scripts/prebuild/mdx-transforms/add-version-to-internal-links/add-version-to-internal-links.mjs
Show resolved
Hide resolved
| }) | ||
| // Replace the matched part of the URL with the versioned path if no version is present | ||
| if (!hasVersionInPath) { | ||
| node.url = node.url.replace(replacePattern, `/$1/${cleanVersion}$2`) |
There was a problem hiding this comment.
Here be dragons....
We might want to be careful here with this logic as this has caused issues on dev portal URL slugs that contain versions. You can see an example of this here where the links in the dropdown get truncated to https://developer.hashicorp.com/vault/docs/v1.19.x/upgrading/upgrade-to-.
I have a dev portal PR open here. I don't know how likely we are to run into that here, but it just seemed worth mentioning.
There was a problem hiding this comment.
Yes this is something I made sure to double check with the regexes I've used here. These regexes include ^ at the beginning which means that the string must start with the version. This means strings like upgrade-to-0.9.2 do not pass the regex. Here are a few example of this:
https://unified-docs-frontend-preview-i54wv6l6r-hashicorp.vercel.app/vault/docs/v1.10.x/commands - upgrade guide link at top of page
https://unified-docs-frontend-preview-i54wv6l6r-hashicorp.vercel.app/vault/docs/v1.10.x/deprecation - Filter Mount Replication Deprecation Notice link in the table
https://unified-docs-frontend-preview-i54wv6l6r-hashicorp.vercel.app/vault/docs/v1.10.x/faq/ssct - Upgrade to 1.10 link
There was a problem hiding this comment.
Ah yeah gotcha. Somehow I didn't notice the caret at first!
…orp/web-unified-docs into leah/fix/internal-links-transform
Description
This PR updates the internal links transform so it runs for all products. This is done by setting up basePaths for each product that doesn't have them in the product config. The old mktg-content-workflow would parse the code and dynamically update these basePaths for each product but since we've changed things for UDR, it is best to manually add the basePaths here for more clarity.
This PR also includes adding a check to determine if the link being changed already has a version in it. If it does, it won't rewrite it to add the current version. This is necessary since some pages include links that authors have manually added a version to.
Testing