search

tianocore / edk2-pytool-extensions

Extensions to the edk2 build system allowing for a more robust and plugin based build system and tool execution environment
Other
60 stars 41 forks source link

Documentation: Fix all broken links #856

Closed Javagedes closed 3 months ago

Javagedes commented 3 months ago

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 /.

... links that started with / ("absolute") and links that ended with / were left as is ...

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 to tianocore.org instead of tianocore.org/edk2-pytool-extenisons.

This pull request updates the documentation to utilize the newly introduced absolute_links validation setting to be relative_to_docs which updates absolute paths to be relative to tianocore.org/edk2-pytool-extensions and updates any path references to point to the markdown file, which is necessary for the relative_to_docs setting to work as expected.

Resolves #855

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 78.70%. Comparing base (bf643b0) to head (a332ea8). Report is 89 commits behind head on master.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/tianocore/edk2-pytool-extensions/pull/856/graphs/tree.svg?width=650&height=150&src=pr&token=vVJxZexcTI&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tianocore)](https://app.codecov.io/gh/tianocore/edk2-pytool-extensions/pull/856?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tianocore) ```diff @@ Coverage Diff @@ ## master #856 +/- ## ========================================== - Coverage 78.75% 78.70% -0.05% ========================================== Files 49 41 -8 Lines 4909 5049 +140 ========================================== + Hits 3866 3974 +108 - Misses 1043 1075 +32 ``` [see 49 files with indirect coverage changes](https://app.codecov.io/gh/tianocore/edk2-pytool-extensions/pull/856/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tianocore)
makubacki commented 3 months ago

It would be nice if you could try to track down a little more info and add it to the PR description or issue.

Javagedes commented 3 months ago

It would be nice if you could try to track down a little more info and add it to the PR description or issue.

Updated the pull request documentation as requested. Thanks!