Update Demo in README with an Asciinema Recording

[camilamacedo86]

What do you want to happen?

The current demo in the README is outdated and should be replaced with a dynamic and maintainable alternative. Using Asciinema, we can create a script and a Makefile target to generate an updated demo, making it easier to refresh and maintain.

Therefore, we need to create a script to record a demo using Asciinema.

In this way, we mainly need:

A script that will

• Start recording a new session.
• Run the required commands to demonstrate Kubebuilder functionality.
• Stop the recording and save the cast file.
• Optionally upload to Asciinema.org for easy sharing.
  Then:
• Add a Makefile target to automate the recording process. (i.e demo-generate)
• Replace the current demo section in README with an embedded Asciinema player. ()

Extra Labels

No response

[wazery]

/assign

[Kuzuri247]

/assign

[chethanm99]

Hi @wazery are you currently working on this issue?

[Kuzuri247]

@chethanm99 I am working on this issue

[Kavinjsir]

@camilamacedo86 I like the idea 👍🏼 how would you like we making a github action as well to automate and track the process?

Also, I wonder how does this issue relative to https://github.com/kubernetes-sigs/kubebuilder/tree/v4.5.1/scripts/demo?
In my own opinion, should we update the script and readme over there instead of creating a new one?

[camilamacedo86]

Hi @Kavinjsir,

Good point — I totally forgot we already have a script for this. (https://github.com/kubernetes-sigs/kubebuilder/tree/v4.5.1/scripts/demo). Thank you 👍

The idea here would be to add a Makefile target so we can quickly run it.
Also, we should ensure we're using Asciinema, and that the demo video is updated accordingly.

So, the actual change here, IMHO, would just be:

• Create a new Makefile target (maybe update-demo)
• That target should call the existing script to generate the video, convert it, and take care of all the steps needed to update the README with the latest demo/tooling version
• Ensure that all is working fine as it should be

When you mentioned adding a GitHub Action, I initially thought about including it in make generate.
However, thinking it through, I don’t think that’s the best idea — it would slow things down unnecessarily, especially since we don’t need to update the demo that often.

Let me know what you think!