📖 Tidy up completion.md by abenn135 · Pull Request #5103 · kubernetes-sigs/kubebuilder

abenn135 · 2025-09-16T19:26:18Z

Tidy up completion.md. The doc as written is confusing and has a few issues. For example, following the instruction:

echo “/usr/local/bin/bash” > /etc/shells

(a) has the wrong kind of double quotes, and (b) blows away all your other shells instead of simply adding /usr/local/bin/bash to the list. This PR cleans that doc up a bit.

linux-foundation-easycla · 2025-09-16T19:26:23Z

✅login: abenn135 / name: Alex Benn / (83fc3b3)

The committers listed above are authorized under a signed CLA.

k8s-ci-robot · 2025-09-16T19:26:27Z

Welcome @abenn135!

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 · 2025-09-16T19:26:28Z

Hi @abenn135. 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.

Details

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.

abenn135 · 2025-09-16T19:33:30Z

(CLA request is pending with my organization)

vitorfloriano

Hi @abenn135 , thanks for working on this! The instructions for Bash completions are much clearer now. I noticed a couple of things that might help the PR move forward more smoothly:

All PRs need to be squashed into a single commit to keep the history clean.
Using a conventional commit title/message for consistency.

Thanks again for improving the docs. This is a nice quality-of-life change. :)

vitorfloriano · 2025-09-18T01:27:41Z

docs/book/src/reference/completion.md

+GNU bash, version 5.1.16(1)-release (x86_64-pc-linux-gnu)
+Copyright (C) 2020 Free Software Foundation, Inc.
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+
+This is free software; you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.


Does this info add any value? Couldn't we just have the command and leave out the output? WDYT?

Sure, I can remove it. Done.

vitorfloriano · 2025-09-18T01:30:16Z

docs/book/src/reference/completion.md

+    ```bash
+    cat /etc/shells | grep '^.*/bash'
+    ```


NIT: I noticed the codeblocks added in this PR have a different identation than the other codeblocks already present in the file. Is there a reason for that?

This indent keeps them within the containing bullet points. So instead of

Blah blah

<code at top level indent, breaking bulleted list>

disconnected bullet

you get

blah blah

<code contained within bullet with paragraph break>

Next bullet continues bulleted list

Oh I see it now 🤔 I hadn't looked at the preview of the file. Yeah, it looks better indented that way.

vitorfloriano · 2025-09-18T01:34:57Z

docs/book/src/reference/completion.md

+## Zsh

-</aside>
+Follow a similar protocol for `zsh` completion.

-<aside class="note">
-<h1>Fish</h1>
+## Fish

+```
 source (kubebuilder completion fish | psub)
-
-</aside>
+```


Could we take this opportunity and also expand on the instructions for Zsh and Fish? Just a suggestion. WDYT?

I don't have zsh nor fish installed, so I wouldn't be able to test those commands unfortunately.

…etc/shells removes all other shells instead of simply adding another shell as an option.

abenn135

Please take another look :)

abenn135 · 2025-09-18T19:23:10Z

docs/book/src/reference/completion.md

+GNU bash, version 5.1.16(1)-release (x86_64-pc-linux-gnu)
+Copyright (C) 2020 Free Software Foundation, Inc.
+License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
+
+This is free software; you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.


Sure, I can remove it. Done.

abenn135 · 2025-09-18T19:26:12Z

docs/book/src/reference/completion.md

+    ```bash
+    cat /etc/shells | grep '^.*/bash'
+    ```


This indent keeps them within the containing bullet points. So instead of

Blah blah

<code at top level indent, breaking bulleted list>

disconnected bullet

you get

blah blah

<code contained within bullet with paragraph break>

Next bullet continues bulleted list

abenn135 · 2025-09-18T19:26:56Z

docs/book/src/reference/completion.md

+## Zsh

-</aside>
+Follow a similar protocol for `zsh` completion.

-<aside class="note">
-<h1>Fish</h1>
+## Fish

+```
 source (kubebuilder completion fish | psub)
-
-</aside>
+```


I don't have zsh nor fish installed, so I wouldn't be able to test those commands unfortunately.

camilamacedo86

Thank you for the contirbution 🥇
/lgtm
/ok-to-test

k8s-ci-robot · 2025-09-22T11:03:18Z

[APPROVALNOTIFIER] This PR is APPROVED

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

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [camilamacedo86]

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 added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Sep 16, 2025

k8s-ci-robot requested review from camilamacedo86 and varshaprasad96 September 16, 2025 19:26

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 16, 2025

abenn135 force-pushed the abenn135/completion-fix branch from e304e21 to c56da72 Compare September 16, 2025 19:31

vitorfloriano reviewed Sep 18, 2025

View reviewed changes

abenn135 force-pushed the abenn135/completion-fix branch from c56da72 to e3fd1f1 Compare September 18, 2025 19:30

Docs: tidy up completion.md. For example, the instruction to add to /…

83fc3b3

…etc/shells removes all other shells instead of simply adding another shell as an option.

abenn135 force-pushed the abenn135/completion-fix branch from e3fd1f1 to 83fc3b3 Compare September 18, 2025 19:31

abenn135 commented Sep 18, 2025

View reviewed changes

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 19, 2025

camilamacedo86 approved these changes Sep 22, 2025

View reviewed changes

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 22, 2025

k8s-ci-robot assigned camilamacedo86 Sep 22, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 22, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 22, 2025

k8s-ci-robot merged commit 9eafd53 into kubernetes-sigs:master Sep 22, 2025
10 checks passed

camilamacedo86 mentioned this pull request Nov 13, 2025

v4.10.0 - Upcoming Release (Draft & Feedback Requested) #5180

Closed

Conversation

abenn135 commented Sep 16, 2025

Uh oh!

linux-foundation-easycla bot commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Sep 16, 2025

Uh oh!

k8s-ci-robot commented Sep 16, 2025

Uh oh!

abenn135 commented Sep 16, 2025

Uh oh!

vitorfloriano left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abenn135 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

camilamacedo86 left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Sep 22, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

linux-foundation-easycla bot commented Sep 16, 2025 •

edited

Loading