Skip to content

Update Demo in README with an Asciinema Recording #4552

Open
@camilamacedo86

Description

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

Extra Labels

No response

Metadata

Metadata

Labels

good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/featureCategorizes issue or PR as related to a new feature.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions