-
Notifications
You must be signed in to change notification settings - Fork 61
Links replace #186
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Links replace #186
Conversation
|
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Welcome @alex-akv! |
|
Hi @alex-akv. Thanks for your PR. I'm waiting for a github.com 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. Instructions 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. |
✅ Deploy Preview for agent-sandbox canceled.
|
| - Agent-sandbox installed ([Installation Guide](../../README.md#Installation) | ||
| - JupyterLab deployed ([Installation Guide](./README.md)) | ||
| - Agent-sandbox installed ([Installation Guide](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/README.md#installation)) | ||
| - JupyterLab deployed ([Installation Guide](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/examples/jupyterlab/README.md)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally it should link to the doc in the same commit (instead of main). Would you explain why this change is needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change is required because the link as is currently does not work on the website (https://agent-sandbox.sigs.k8s.io/docs/guides/jupyterlab/), by changing it to an actual link it ensures that the website sends you to the github link instead of https://agent-sandbox.sigs.k8s.io/docs/INSTALL.md (which it does now), this issue persists everywhere we have this.
|
/ok-to-test |
barney-s
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for fixing the broken links on the documentation site. I understand this change is to make the links work on agent-sandbox.sigs.k8s.io.
However, hardcoding links to the main branch will cause the documentation to be misleading for users browsing older tagged versions. The best long-term solution is to configure the Hugo static site generator to correctly resolve these relative links. For now, could we explore a relative link format that is compatible with Hugo? If not, we should create a follow-up issue to address the documentation build process.
| - Agent-sandbox installed ([Installation Guide](../../README.md#Installation) | ||
| - JupyterLab deployed ([Installation Guide](./README.md)) | ||
| - Agent-sandbox installed ([Installation Guide](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/README.md#installation)) | ||
| - JupyterLab deployed ([Installation Guide](https://github.com/kubernetes-sigs/agent-sandbox/blob/main/examples/jupyterlab/README.md)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While this fixes the link on the rendered website, it makes the documentation less maintainable and potentially misleading for users on different versions. Pinning the link to the main branch means that anyone viewing this document from a tagged release will not see the corresponding version of the installation guide. We should investigate a solution within our static site generator to resolve these links correctly without hardcoding the branch.
No description provided.