Fix broken component configuration link in Stacks tfcomponent docs - #3121
Open
Gaalbu wants to merge 1 commit into
Open
Fix broken component configuration link in Stacks tfcomponent docs#3121Gaalbu wants to merge 1 commit into
Gaalbu wants to merge 1 commit into
Conversation
|
|
Contributor
Vercel Previews Deployed
|
Contributor
Broken Link CheckerThis PR contains broken links, but won't be blocked. Use this report to improve content quality: Quick Actions
Need Help?
Internal LinksExternal LinksSummary
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #1247
What was wrong
In
content/terraform/v1.13.x/docs/language/block/stack/tfcomponent/index.mdx(line 16 as referenced in the issue), the link text "defining Stack component configuration files" pointed to:This is a relative path (missing the leading
/), while every other link in this repo's.mdxcontent uses absolute paths rooted at the product (e.g. the very same file's other links:/terraform/language/block/stack/tfcomponent/component,/terraform/language/block/locals, etc.). Without the leading slash, the link resolves relative to the current page instead of to the intended top-level route, producing a broken/invalid link.How I determined the correct target
The issue reporter noted they couldn't confidently identify the intended destination, so I verified it two ways:
content/terraform/v1.13.x/docs/language/stacks/component/config.mdxexists, withpage_title: Define configurationand content that opens with "In the component configuration file, you declare what infrastructure components are part of the Stack" — this is precisely what the link text ("defining Stack component configuration files") describes.https://developer.hashicorp.com/terraform/language/stacks/component/configrenders that same "Define configuration" page, confirming/terraform/language/stacks/component/configis the correct, currently-live absolute path.So the only defect was the missing leading
/; the path segments themselves were already correct.Fix
Changed:
The identical broken link (copy-pasted per-version, as is this repo's content structure) also existed in the
v1.14.x,v1.15.x, andv1.16.x (beta)copies of this same file. I fixed all four in this PR to avoid leaving three more instances of the same known bug for another link-checker report — this repo's own history shows this cross-version-folder pattern for single-bug fixes (e.g. the vaultmigration-checklist.mdxfixes applied acrossv1.18.x–v2.xin one PR each).Testing
Manually verified the corrected route resolves on the live site (
developer.hashicorp.com/terraform/language/stacks/component/config) and matches the link text's intent. The repo'sbroken-linkcheck (scripts/broken-link.mjs) requires a local Docker-based site build, which was out of scope for this one-line, four-file link fix; the fix follows the exact absolute-path convention used by every other link in the same file.