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

🌱 fix readme links #1406

Merged
merged 2 commits into from
Aug 5, 2024
Merged

🌱 fix readme links #1406

merged 2 commits into from
Aug 5, 2024

Conversation

buhodev
Copy link
Contributor

@buhodev buhodev commented Jul 29, 2024

What this PR does / why we need it:

Fix the broken links on the README. Now all links point to the correct files/folders.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:

Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.

TODOs:

  • squash commits
  • include documentation
  • add unit tests

@buhodev buhodev requested a review from janiskemper July 29, 2024 14:16
@syself-bot syself-bot bot added the size/XS Denotes a PR that changes 0-20 lines, ignoring generated files. label Jul 29, 2024
Copy link
Contributor

@janiskemper janiskemper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@syself-bot syself-bot bot added size/M Denotes a PR that changes 50-200 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-20 lines, ignoring generated files. labels Aug 5, 2024
@buhodev
Copy link
Contributor Author

buhodev commented Aug 5, 2024

first link I clicked on was introduction and I got this: https://github.com/syself/cluster-api-provider-hetzner/blob/buho/fix-readme-links/docs/caph/01-getting-started/01-introduction

It looks like github doesn't link to the proper file when not specifying the extension (.md). This works on vscode tho. I pushed a fix that adds the .md extension to (hopefully) all relative links in the docs. Now everyone should be able to click on any link here on github, their editor, or on the hosted website and don't get a 404.

@buhodev buhodev requested a review from janiskemper August 5, 2024 04:19
@batistein batistein merged commit f685233 into main Aug 5, 2024
4 checks passed
@batistein batistein deleted the buho/fix-readme-links branch August 5, 2024 13:04
batistein added a commit that referenced this pull request Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/M Denotes a PR that changes 50-200 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants