📖 Use full URL for contrib source paths #6090
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
In the CONTRIBUTING file, there is a section on the *Contributors Ladder* that lists the sub areas with the cluster-api project. These link out to the source for each area. When viewing the CONTRIBUTING.md file via GitHub, these links work great because they are relative to that file. But this file also gets pulled in to the published Cluster-API book [0]. When viewed from this location, these links will try to go to relative paths within the book, which do not exist. To address this, this changes the link targets to the full GitHub URL to the source code so that it works as expected in both the GitHub and book rendering of the content. [0] https://cluster-api.sigs.k8s.io/contributing#contributors-ladder Signed-off-by: Sean McGinnis <[email protected]>
k8s-ci-robot
added
cncf-cla: yes
|
Thank you! Small downside is that those links are not versioned, but I think it's definitely better than the current broken links |
|
Forgot |
k8s-ci-robot
added
the
lgtm
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: neolit123 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
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.
What this PR does / why we need it:
In the CONTRIBUTING file, there is a section on the Contributors
Ladder that lists the sub areas with the cluster-api project. These
link out to the source for each area.
When viewing the
CONTRIBUTING.mdfile via GitHub, these links work greatbecause they are relative to that file. But this file also gets pulled
in to the published Cluster-API book. When viewed from this
location, these links will try to go to relative paths within the book,
which do not exist.
To address this, this changes the link targets to the full GitHub URL to
the source code so that it works as expected in both the GitHub and book
rendering of the content.