Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Fix all broken links #856

Merged
merged 1 commit into from
Jul 29, 2024

Conversation

Javagedes
Copy link
Contributor

@Javagedes Javagedes commented Jul 26, 2024

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

@Javagedes Javagedes added bug Something isn't working documentation Improvements or additions to documentation labels Jul 26, 2024
@Javagedes Javagedes added this to the v0.27.11 milestone Jul 26, 2024
Copy link

codecov bot commented Jul 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

@@            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

@makubacki
Copy link
Member

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 Javagedes reopened this Jul 29, 2024
@Javagedes
Copy link
Contributor Author

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!

@Javagedes Javagedes merged commit b4a5ccc into tianocore:master Jul 29, 2024
33 of 34 checks passed
@Javagedes Javagedes deleted the fix-stuart-documentation branch July 29, 2024 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc]: Broken links on "Building a Platform" page
3 participants