Fix some broken URLs in KataConfig description #456
Conversation
|
I created https://issues.redhat.com/browse/HCIDOCS-463 to set up permanent anchors in the docs for NFD and peer pods. @gkurz Can you create a variable for the OSC version number in the URL? |
Signed-off-by: Greg Kurz <groug@kaod.org>
gkurz
force-pushed
the
fix-doc-link-in-kataconfig
branch
from
a36d027 to
0d6cc96
Compare
|
Thanks @apinnick ! I've updated the links according to your suggestion. Please approve. It is a bit unfortunate that the publication system doesn't support a "latest" version. For the time being, it is acceptable to point to a numerical version as long as the steps documented there remain valid but it would be great to find a way to have permanent links. |
|
@gkurz: The following tests failed, say
Full PR test history. Your PR dashboard. 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. I understand the commands that are listed here. |
| @@ -31,7 +31,7 @@ type KataConfigSpec struct { | |||
|
|
|||
| // CheckNodeEligibility is used to detect the node(s) eligibility to run Kata containers. | |||
| // This is currently done through the use of the Node Feature Discovery Operator (NFD). | |||
| // For more information on how the check works, please refer to the sandboxed containers documentation - https://docs.openshift.com/container-platform/latest/sandboxed_containers/deploying-sandboxed-container-workloads.html | |||
| // For more information on how the check works, please refer to the sandboxed containers documentation - https://docs.redhat.com/en/documentation/openshift_sandboxed_containers/1.6/html-single/user_guide/index#about-node-eligibility-checks_about-osc | |||
There was a problem hiding this comment.
assuming 1.6 is intentional here
There was a problem hiding this comment.
Unfortunately, that is a publishing platform limitation. Currently, version numbers are hard-coded in URLs. Maybe the new tooling platform will allow more flexibility.
Trivial update in code comments to use the appropriate doc link.