docs: fix relative to absolute links on README.md #1776
Merged
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
Pull Request Test Coverage Report for Build 1712381687
💛 - Coveralls |
lukpueh
requested changes
Jan 18, 2022
There was a problem hiding this comment.
Thanks for the patch, @kairoaraujo! Please fix typo and this is good to go.
This commit fixes the relatives links on README.md, adding absolute links. The PyPI renders the README.md as an HTML page on the landing page of the python-tuf package. If the links are not absolute links to the files in git repository, they will fail. Fixes: theupdateframework#1739 Signed-off-by: Kairo de Araujo <kdearaujo@vmware.com>
kairoaraujo
force-pushed
the
issue#1739/relative_links_404
branch
from
6ecd1bc
to
0a4d88a
Compare
lukpueh
approved these changes
Jan 19, 2022
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.
This commit fixes the relatives links on README.md, adding absolute
links.
The PyPI renders the README.md as an HTML page on the landing page
of the python-tuf package. If the links are not absolute links to
the files in git repository, they will fail.
Fixes: #1739
Signed-off-by: Kairo de Araujo kdearaujo@vmware.com