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.

Sign up for GitHub

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

Jump to bottom

docs: relative links in README 404 on PyPI project page #1739

Closed
lukpueh opened this issue Dec 21, 2021 · 0 comments · Fixed by #1776
Closed

docs: relative links in README 404 on PyPI project page #1739

lukpueh opened this issue Dec 21, 2021 · 0 comments · Fixed by #1776
Assignees
@kairoaraujo
Labels
1.0.0 blockers To be addressed before 1.0.0 release documentation Documentation of the project as well as procedural documentation
Milestone
Sprint 15

Comments

@lukpueh
Copy link
Member

lukpueh commented Dec 21, 2021

The main README of the repo is also rendered on pypi. Links that use relative paths to other GitHub documents 404 there. Let's:

  • fix those links (use full URLs), and
  • maybe make sure this doesn't happen in the future
    -> quick fix: add big HTML-comment warning to readme header
    -> more invested fix: check readme links in a github action?
@lukpueh lukpueh added the documentation Documentation of the project as well as procedural documentation label Dec 21, 2021
@jku jku mentioned this issue Jan 12, 2022
Closed
@jku jku added the 1.0.0 blockers To be addressed before 1.0.0 release label Jan 12, 2022
@jku jku added this to the Sprint 15 milestone Jan 12, 2022
kairoaraujo pushed a commit to kairoaraujo/python-tuf that referenced this issue Jan 17, 2022
docs: fix relative to absolute links on README.md
5c1fb82 
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 pushed a commit to kairoaraujo/python-tuf that referenced this issue Jan 17, 2022
docs: fix relative to absolute links on README.md
191dd86 
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 pushed a commit to kairoaraujo/python-tuf that referenced this issue Jan 17, 2022
docs: fix relative to absolute links on README.md
6ecd1bc 
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 kairoaraujo mentioned this issue Jan 17, 2022
Merged
3 tasks
kairoaraujo pushed a commit to kairoaraujo/python-tuf that referenced this issue Jan 18, 2022
docs: fix relative to absolute links on README.md
0a4d88a 
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kairoaraujo kairoaraujo

Labels
1.0.0 blockers To be addressed before 1.0.0 release documentation Documentation of the project as well as procedural documentation
Projects
None yet
Milestone
Sprint 15
Development

Successfully merging a pull request may close this issue.

docs: fix relative to absolute links on README.md kairoaraujo/python-tuf
3 participants
@jku @kairoaraujo @lukpueh