馃摉 Added link for cronjob tutorial #3411
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
needs-ok-to-test
|
Hi @lauchokyip. 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. 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/test-infra repository. |
| @@ -1,7 +1,7 @@ | |||
| # Admission Webhook for Core Types | |||
|
|
|||
| It is very easy to build admission webhooks for CRDs, which has been covered in | |||
| the CronJob tutorial. Given that kubebuilder doesn't support webhook scaffolding | |||
| the [CronJob tutorial](https://github.com/kubernetes-sigs/kubebuilder/tree/master/docs/book/src/cronjob-tutorial). Given that kubebuilder doesn't support webhook scaffolding | |||
There was a problem hiding this comment.
All links need to be within alias so
| the [CronJob tutorial](https://github.com/kubernetes-sigs/kubebuilder/tree/master/docs/book/src/cronjob-tutorial). Given that kubebuilder doesn't support webhook scaffolding | |
| the [CronJob tutorial][cronjob-tutorial]. Given that kubebuilder doesn't support webhook scaffolding |
Either, they need to be defined at the bottom of the page, and when the link is for the docs itself, it must be using the relative path.
Can you please change it out?
There was a problem hiding this comment.
Sure, I observed there are a lot of links that aren't within aliases tho
There was a problem hiding this comment.
There was a problem hiding this comment.
Hi @lauchokyip,
Feel free to correct any links you come across that lack aliases. Ideally, they shouldn't exist.
Utilizing aliases and adhering to the documentation standards assist us in keeping the documents well-maintained.
There was a problem hiding this comment.
Also, if the following criteria for the docs are not in your Contributing guide, would be great get your help to add them:
To keep the maintainability of our docs, links must be:
- Added with alias:
// TODO add example
- They should be added at the bottom of the doc
- If the link is for a Kubebuilder doc then, it should use relative paths instead of the URL
There was a problem hiding this comment.
Hi @lauchokyip,
Feel free to correct any links you come across that lack aliases. Ideally, they shouldn't exist.
Utilizing aliases and adhering to the documentation standards assist us in keeping the documents well-maintained.
We could gather help from good-first-issue . I don't have the resources now but I can lead the effort when I have time
There was a problem hiding this comment.
Also, if the following criteria for the docs are not in your Contributing guide, would be great get your help to add them:
To keep the maintainability of our docs, links must be:
- Added with alias:
// TODO add example
- They should be added at the bottom of the doc
- If the link is for a Kubebuilder doc then, it should use relative paths instead of the URL
Sounds good, I think this should be in another PR since this title is "Added link for cronjob tutorial" , wdyt?
There was a problem hiding this comment.
HI @lauchokyip,
I think the most important is we ensure via reviews that we follow up that.
But if someone would like to fix the places that we get the link merged without comply with the rule all fine.
There was a problem hiding this comment.
@camilamacedo86 , Do you mean by adding what you proposed into https://github.com/kubernetes-sigs/kubebuilder/blob/master/CONTRIBUTING.md#how-to-contribute-to-docs? Sorry I don't quite understand what "ensure via reviews that we follow up that" mean?
I was thinking of also adding "For a smooth PR process, please ensure you read the CONTRIBUTING.md and that you include the following information:" and point people to the CONTRIBUTING guideline
k8s-ci-robot
added
ok-to-test
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, lauchokyip The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
Description: Added link for cronjob tutorial
Motivation: When reading through kubebuilder book, I saw the the Cronjob tutorial was mentioned but there was no link that points to it