Skip to content

📖 Update kubebuilder demo svg in README #3638

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 26, 2023
Merged

📖 Update kubebuilder demo svg in README #3638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Follow the [instructions](https://book.kubebuilder.io/quick-start.html#installat

See the [Getting Started](https://book.kubebuilder.io/quick-start.html) documentation.

![Quick Start](docs/gif/kb-demo.v2.0.1.svg)
![Quick Start](docs/gif/kb-demo.v3.11.1.svg)

Also, ensure that you check out the [Deploy Image](https://book.kubebuilder.io/plugins/deploy-image-plugin-v1-alpha.html)
Plugin. This plugin allows users to scaffold API/Controllers to deploy and manage an
Expand Down
1 change: 0 additions & 1 deletion docs/gif/kb-demo.v2.0.1.svg
View file
Open in desktop

This file was deleted.

1 change: 1 addition & 0 deletions docs/gif/kb-demo.v3.11.1.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion scripts/demo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,14 @@ cd /tmp/kb-demo
asciinema rec
<path-to-KB-repo>/scripts/demo/run.sh

# After each step, press <Enter> to proceed to the next step

<CTRL-C> to terminate the script
<CTRL-D> to terminate the asciinema recording
<CTRL-C> to save the recording locally

# Edit the recorded file by editing the controller-gen path
# Once you are happy with the recording, use svg-term program to generate the svg

svg-term --cast=<movie-id> --out demo.svg --window
svg-term --in=<cast-file-path> --out demo.svg --window
```
2 changes: 1 addition & 1 deletion scripts/demo/run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ run "kubebuilder create api --group batch --version v1 --kind CronJob"
clear

desc "Let's take a look at the API and Controller files"
run "tree ./api ./controllers"
run "tree ./api ./internal/controller"
clear

desc "Install CRDs in Kubernetes cluster"
Expand Down