kubebuilder icon indicating copy to clipboard operation
kubebuilder copied to clipboard

Update Demo in README with an Asciinema Recording

Open camilamacedo86 opened this issue 9 months ago • 6 comments
trafficstars

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. (asciicast)

Extra Labels

No response

camilamacedo86 avatar Feb 10 '25 11:02 camilamacedo86