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

Update Demo in README with an Asciinema Recording #4552

Open
camilamacedo86 opened this issue Feb 10, 2025 · 1 comment
Open

Update Demo in README with an Asciinema Recording #4552

camilamacedo86 opened this issue Feb 10, 2025 · 1 comment
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/feature Categorizes issue or PR as related to a new feature.

Comments

@camilamacedo86
Copy link
Member

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 camilamacedo86 added kind/feature Categorizes issue or PR as related to a new feature. 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 Feb 10, 2025
@wazery
Copy link
Contributor

wazery commented Feb 10, 2025

/assign

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/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

No branches or pull requests

2 participants