Website reorg + fixing all the links #257
Conversation
k8s-ci-robot
added
the
do-not-merge/work-in-progress
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: alex-akv The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for agent-sandbox ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
k8s-ci-robot
added
the
needs-ok-to-test
|
Hi @alex-akv. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
k8s-ci-robot
added
size/L
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
|
/ok-to-test |
k8s-ci-robot
added
ok-to-test
| @@ -1,6 +1,6 @@ | |||
| --- | |||
There was a problem hiding this comment.
This will break old URLs. For backward compatibility, try adding aliases.
There was a problem hiding this comment.
Added aliases for all renamed titles in commit: 59b25fb
| @@ -0,0 +1,8 @@ | |||
| --- | |||
There was a problem hiding this comment.
Please stick with hyphens (e.g. runtime-templates, computer-use).
Best practice: Use hyphens (-) to separate words in URLs, as recommended by Google and other search engines. Hyphens enhance readability for users and help search engines identify distinct concepts, whereas underscores (_) are often treated as word joiners rather than separators.
There was a problem hiding this comment.
Ensured to use hypens instead of underscores in commit: 59b25fb
| {{- $content = replaceRE `\]\(\./README\.md\)` "](/docs/examples/jupyterlab/)" $content -}} | ||
| {{- $content = replaceRE `\]\(README\.md(#[^)]+)?\)` (printf "](%s$1)" (strings.TrimSuffix "/" $sectionPath)) $content -}} | ||
| {{- $content = replaceRE `\]\(\.\.\/\.\./(README|INSTALL)\.md(#[^)]+)?\)` "](/docs/overview/$2)" $content -}} | ||
|
|
There was a problem hiding this comment.
This is becoming a maintenance bottleneck. If a directory moves, the site build breaks or generates dead links silently.
For maintenance, consider moving these mapping rules into a Hugo data file (e.g. site/data/link_replacements.yaml) so the code logic remains generic. This way, we can separate the code logic for looping an replacing from the data file (specific paths).
To avoid silent failures, we could introduce a link checker in CI.
3 participants
This PR includes hugo website reorganisation to better match the examples and the final links fix to match hugo expected links structure and new website reorg.