Skip to content
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

📖 Docs fixes for code blocks, links and minor typos #3491

Merged
merged 1 commit into from Nov 3, 2023

Conversation

yuridekim
Copy link
Contributor

I've recently come across some issues while reading the Kubebuilder document.

This PR mainly addresses:

  • formatting issues that do not properly render code blocks
  • broken links that reference the Cronjob code
  • minor typos and grammar for a smoother reading experience

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 10, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: yuridekim / name: Yuri Kim (b69a7fc)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jul 10, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @yuridekim!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubebuilder has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jul 10, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @yuridekim. 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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 10, 2023
Copy link
Member

@varshaprasad96 varshaprasad96 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good after @camilamacedo86's comment is addressed.

Thanks for working on this @yuridekim!
/lgtm

docs/book/src/reference/webhook-overview.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 24, 2023
@k8s-ci-robot
Copy link
Contributor

@yuridekim: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-kubebuilder-e2e-k8s-1-25-3 da00426 link true /test pull-kubebuilder-e2e-k8s-1-25-3

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 5, 2023
@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. and removed cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 9, 2023
@yuridekim yuridekim force-pushed the master branch 2 times, most recently from f938063 to b74792d Compare August 9, 2023 07:25
@Kavinjsir
Copy link
Contributor

@yuridekim Would you squash the commits into one and rebase the branch based off the lastest master branch?

That should help fix the docs preview failure in CI.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Sep 11, 2023
@yuridekim
Copy link
Contributor Author

@yuridekim Would you squash the commits into one and rebase the branch based off the lastest master branch?

That should help fix the docs preview failure in CI.

Thanks, done the squashing and the rebasing. Ready for review.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 13, 2023
Add revisions for markdown changes

Refactor link to relative path
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Sep 17, 2023
@camilamacedo86
Copy link
Member

/test pull-kubebuilder-e2e-k8s-1-25-3

that is great for me !!!!

🎉

@k8s-ci-robot
Copy link
Contributor

@camilamacedo86: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

  • /test pull-kubebuilder-e2e-k8s-1-26-6
  • /test pull-kubebuilder-e2e-k8s-1-27-3
  • /test pull-kubebuilder-e2e-k8s-1-28-0
  • /test pull-kubebuilder-test

Use /test all to run all jobs.

In response to this:

/test pull-kubebuilder-e2e-k8s-1-25-3

that is great for me !!!!

🎉

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.

Copy link
Member

@camilamacedo86 camilamacedo86 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 13, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, yuridekim

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 13, 2023
@camilamacedo86 camilamacedo86 reopened this Nov 3, 2023
@k8s-ci-robot k8s-ci-robot merged commit 4c6283c into kubernetes-sigs:master Nov 3, 2023
30 of 31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants