github/kured
1
0
Fork 0
mirror of https://github.com/kubereboot/kured.git synced 2026-08-19 03:16:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change relative link to absolute link

Browse Source 
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>
This commit is contained in:
Jean-Philippe Evrard
2024-08-07 09:58:20 +02:00
parent 9a33096e73
commit 3f39fd0943
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+1 -1
View File
@@ -9,7 +9,7 @@ In any case, it will make sense to familiarise yourself with the main
options, which is helpful for testing. The "building" section in
particular makes sense if you are planning to contribute code.
[slack]: README.md#getting-help
[slack]: https://github.com/kubereboot/kured/blob/main/README.md#getting-help
[issues]: https://github.com/kubereboot/kured/issues
[documentation]: https://kured.dev/docs