Documentation: Fix all broken links #609
Merged
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.
MkDocs v1.5.0 Updated how links were evaluated (See "Expanded Validaton of links" section). Before 1.5.0, most links in our documentation were left "untouched" as they either started or ended with a
/
.However these links are now properly evaluated, which broke most links in edk2-pytool-extensions documentation. With this new evaluation, All of our links that started absolute (
/
) were now linking relative totianocore.org
instead oftianocore.org/edk2-pytool-library
.This pull request updates the documentation to utilize the newly introduced
absolute_links
validation setting to berelative_to_docs
which updates absolute paths to be relative totianocore.org/edk2-pytool-extensions
and updates any path references to point to the markdown file, which is necessary for therelative_to_docs
setting to work as expected.