website: Fix links to Docsy styles and shortcodes#4424
Conversation
## What this PR does This PR fixes broken and outdated documentation links related to the Docsy theme. ### Changes #### 1. Fix broken Docsy submodule GitHub links The documentation previously linked to files inside the `themes/docsy` Git submodule through the `kubeflow/website` repository. These URLs returned **404** because GitHub does not resolve submodule contents through the parent repository's tree view. Updated the following links to point directly to the corresponding files in the upstream **google/docsy** repository at the pinned commit used by Kubeflow: * `assets/scss` directory * `_variables.scss` Using the specific commit hash ensures the links remain consistent with the version of Docsy currently used by the website. #### 2. Update Docsy shortcode documentation links Updated the Docsy shortcode documentation links from the older path: * `/docs/adding-content/shortcodes/` to the current canonical path: * `/docs/content/shortcodes/` This affects references to: * `blocks-cover` * `blocks-link-down` The existing URLs still resolve via redirects, but updating them avoids relying on legacy paths and reduces the risk of future link rot. ## Why These changes improve the accuracy and maintainability of the documentation by: * Fixing broken GitHub links that resulted in 404 errors. * Pointing readers to the current canonical Docsy documentation. * Reducing future maintenance caused by stale or redirected URLs. ## How I tested it * Verified that the updated GitHub URLs resolve to the correct files in the upstream Docsy repository (no 404s). * Verified that the updated Docsy documentation page contains the `#blocks-cover` and `#blocks-link-down` anchors and that both links navigate correctly. Signed-off-by: Ishan Sarkar <sarkarishan2005@gmail.com>
|
Hi @Ishan-AI-coder. Thanks for your PR. I'm waiting for a kubeflow 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/test-infra repository. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
|
🚫 This command cannot be processed. Only organization members or owners can use the commands. |
1 participant
What this PR does
This PR fixes broken and outdated documentation links related to the Docsy theme.
Changes
1. Fix broken Docsy submodule GitHub links
The documentation previously linked to files inside the
themes/docsyGit submodule through thekubeflow/websiterepository. These URLs returned 404 because GitHub does not resolve submodule contents through the parent repository's tree view.Updated the following links to point directly to the corresponding files in the upstream google/docsy repository at the pinned commit used by Kubeflow:
assets/scssdirectory_variables.scssUsing the specific commit hash ensures the links remain consistent with the version of Docsy currently used by the website.
2. Update Docsy shortcode documentation links
Updated the Docsy shortcode documentation links from the older path:
/docs/adding-content/shortcodes/to the current canonical path:
/docs/content/shortcodes/This affects references to:
blocks-coverblocks-link-downThe existing URLs still resolve via redirects, but updating them avoids relying on legacy paths and reduces the risk of future link rot.
Why
These changes improve the accuracy and maintainability of the documentation by:
How I tested it
#blocks-coverand#blocks-link-downanchors and that both links navigate correctly.Description of Changes
Related Issues
Closes: #
Related: #
Checklist