Skip to content

Clean documentation & examples#377

Merged
mjudeikis merged 1 commit into
kbind-dev:mainfrom
mjudeikis:cleanup.20251112
Nov 14, 2025
Merged

Clean documentation & examples#377
mjudeikis merged 1 commit into
kbind-dev:mainfrom
mjudeikis:cleanup.20251112

Conversation

@mjudeikis

Copy link
Copy Markdown
Contributor

Summary

As per early users feedback - chanve bind dev create output to be more readable
Start consolidating our yaml files as they are all around the place
Remove some debug left-overs
image

What Type of PR Is This?

/kind cleanup

Related Issue(s)

Fixes #

Release Notes

NONE

@mjudeikis mjudeikis requested a review from a team as a code owner November 12, 2025 09:21
@mjudeikis mjudeikis changed the title Clean documentation, examples. Start consolidating towards "cowboys" Clean documentation & examples Nov 12, 2025
Comment thread cli/pkg/kubectl/dev/plugin/create.go Outdated
return nil
}

// Run executes the create command with plain output (no styling)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The comment says no styling but then it executes the WithColors method?^^
I also remember a pattern where the colours codes were used from a map and for uncoloured output the map was just empty.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

left-over. Originally added bubble tea + some fancy flows but kinda was overkill

```

2. Start kcp
1. Start kcp

@ntnn ntnn Nov 12, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Unrelated to this change but after cloning none of the build commands are available. We need a make build step before bootstrapping kcp.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

as this is in dev-docs, I suspect some thinking from developers :D but yes

@mjudeikis mjudeikis enabled auto-merge (squash) November 12, 2025 10:00
Comment thread cli/pkg/kubectl/dev/plugin/create.go Outdated
coderabbitai[bot]
coderabbitai Bot previously approved these changes Nov 12, 2025
--version v1.16.2 \
--set crds.enabled=true \
cert-manager jetstack/cert-manager
kubectl bind dev create

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

In the kcp setup the locally built kubectl-bind is used, for the kind setup the user is expected to install the plugin.

It makes sense because the kcp setup also uses the run-kcp recipe, so the repo needs to be cloned, and the kind setup doesn't need anything outside of kind and the plugin. Then again in the developer docs we can expect people to have cloned the repo.

But should this be the same? Imho this is fine, just wanna put that up for discussion.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

For example, I have all my repos bin dirs in the PATH, so this kinda works. I think in general people should try, test and update :) we can use local binary reference too.

@xmudrii xmudrii left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Some very tiny nits, but high-level, this looks pretty solid. I'll try to give it a try sometime soon.

Comment thread deploy/examples/template-cowboys.yaml Outdated
app: cowboy
component: config No newline at end of file
namespaces:
- name: wild-west No newline at end of file

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Nit: new line.

Comment thread deploy/examples/template-sheriffs.yaml Outdated
status: {}
app: sheriff
namespaces:
- name: sheriff-operations No newline at end of file

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Nit: new line.

Comment thread deploy/examples/collection.yaml Outdated
- name: mangodb
- name: foo No newline at end of file
- name: cowboys
- name: sheriffs No newline at end of file

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Nit: new line.

Comment thread contrib/kcp/README.md
```

2. Start kcp
1. Start kcp

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is pretty much what is in docs/content/developers/dev-environments.md - maybe we should just scrap what is mentioned here and point to those docs?

I'd prefer that over keeping copies (roughly) in sync.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

this will be fully refactored in follow-up pr (based on this). so bare with me for a bit :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

here #376

Add CLI styling to show output cleaner

Signed-off-by: Mangirdas Judeikis <mangirdas@judeikis.lt>
On-behalf-of: @SAP mangirdas.judeikis@sap.com
@mjudeikis mjudeikis merged commit 1d0dcc3 into kbind-dev:main Nov 14, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants