Change includes files to use absolute URIs to fix broken relative links #561
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
…des files are used in multiple nesting levels The issue is that the include will generate links from the perspective of the including file, resulting in many missing /latest/'s and other variations of broken links
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.
When an include file generates a link, it is referenced relative to the generating file's path. This means that reusing the include in different nesting levels and context across the docs will result in inconsistent links that will always be broken (many are missing the latest/ version namespace, for instance.)
The easiest/laziest solution is to always generate pointing to the live website, latest version, with an absolute URI. If each version from Mike can instead have a template-available variable that is the hostname and version number (or latest), then we could improve this by generating self-contained links instead of always-prod ones.