Change relative link to absolute link #965
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
Without this patch, the copy of the contributing.md into our doc site (generated from [1] and [2]) will refer to a local README.md into the website git repo, which is not existing. This is a problem, as it generates dead link for lychee on local runs in 'content/en/docs/development.md'. This fixes it by making the link absolute, while keeping the CONTRIBUTING.md in sync between repos. The alternative would be to edit the site generator in [1]. Yet, I believe having an absolute link does not hurt, because we already use the full git repo in other parts of the same documentation. [1]: https://github.com/kubereboot/website/blob/5da8aba559460ef7a8c363ab021328cba9e0deda/hack/gen-content.py [2]: https://github.com/kubereboot/website/blob/5da8aba559460ef7a8c363ab021328cba9e0deda/external-sources/kubereboot/kured Signed-off-by: Jean-Philippe Evrard <open-source@a.spamming.party>
|
I think it could be a problem in https://github.com/kubereboot/website/commits/main/hack/gen-content.py |
|
This PR was automatically considered stale due to lack of activity. Please refresh it and/or join our slack channels to highlight it, before it automatically closes (in 7 days). |
|
@dholbach Please read my comment again ? |
dholbach
approved these changes
Oct 11, 2024
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.
Without this patch, the copy of the contributing.md into our doc site (generated from 1 and 2) will refer to a local README.md into the website git repo, which is not existing.
This is a problem, as it generates dead link for lychee on local runs in 'content/en/docs/development.md'.
This fixes it by making the link absolute, while keeping the CONTRIBUTING.md in sync between repos. The alternative would be to edit the site generator in 1. Yet, I believe having an absolute link does not hurt, because we already use the full git repo in other parts of the same documentation.