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

Gif in the README is outdated #3609

Closed
camilamacedo86 opened this issue Sep 11, 2023 · 10 comments · Fixed by #3638
Closed

Gif in the README is outdated #3609

camilamacedo86 opened this issue Sep 11, 2023 · 10 comments · Fixed by #3638
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug.

Comments

@camilamacedo86
Copy link
Member

camilamacedo86 commented Sep 11, 2023

What broke? What's expected?

The Gif in the README is outdated. Therefore, this issue is for we record a new gif using the latest release doing exactly the same steps.

See: https://github.com/kubernetes-sigs/kubebuilder#getting-started

Reproducing this issue

No response

KubeBuilder (CLI) Version

master

PROJECT version

No response

Plugin versions

No response

Other versions

No response

Extra Labels

No response

@camilamacedo86 camilamacedo86 added kind/bug Categorizes issue or PR as related to a bug. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels Sep 11, 2023
@ashutosh887
Copy link
Contributor

I'll do this
Please share the SVG @camilamacedo86

@camilamacedo86
Copy link
Member Author

HI @ashutosh887

That is great news. Not sure if I understand your comment.
See that we have a GIF now: https://github.com/kubernetes-sigs/kubebuilder#getting-started
Therefore, the task would to be to record a new one (updated) and then replace the current one for the new one.

@ashutosh887
Copy link
Contributor

Okay I thought I'll get a GIF from community

@Sajiyah-Salat
Copy link
Contributor

Sajiyah-Salat commented Sep 20, 2023

@camilamacedo86 So what commands can we run in the gif.

@ashutosh887
Copy link
Contributor

Yeah that's what I was asking if not available @camilamacedo86

@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Sep 23, 2023

Hi @ashutosh887 and @Sajiyah-Salat,

@camilamacedo86 So what commands can we run in the gif.
Yeah that's what I was asking if not available @camilamacedo86
Hi there! 😊

Ah, I see now! Have you had a chance to check out the GIF that we have up on the README? Here’s the link: kb-demo.v2.0.1.svg.

The plan here would be to run precisely the same commands as showcased, but with the latest version. This is because the layout, among other things, has changed.

However, if you’re looking to expand on this and maybe add an extra step at the end to showcase the plugins, that sounds like a wonderful idea! The aim would be to illustrate that the tool can also accommodate optional scaffolds through the use of plugins. For instance, we could create an API with the deploy image, like this:

kubebuilder create api --group example.com --version v1alpha1 --kind Busybox --image=busybox:1.28 --plugins="deploy-image/v1-alpha"

This would demonstrate that the corresponding code is generated in the controller to deploy and manage the specified image. How does that sound to you?

Looking forward to your thoughts and excited to see how we can make this even better! 🌟

@ashutosh887
Copy link
Contributor

Yes that makes a sense @camilamacedo86

@ashutosh887
Copy link
Contributor

/assign

@ashutosh887
Copy link
Contributor

@MaGaroo Which tool did you use to generate SVG/this snippet?

@MaGaroo
Copy link
Contributor

MaGaroo commented Sep 27, 2023

@MaGaroo Which tool did you use to generate SVG/this snippet?

As described in scripts/demo/README.md, asciinema is used for recording and svg-term is used for conversion to svg.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants