carvel-dev / carvel-dev/carvel

Update kapp-controller asciinema video to show more realistic PackageRepository

Open
#249 0 comments 0 reactions 0 assignees View on GitHub
carvel accepted
Dominant language
HTML
Stars
408
Forks
148
PR merge metrics
No merged PRs in 30d

Description

Currently, the kapp-controller webpage features a small demo video shown [here](https://carvel.dev/kapp-controller/#examples). The PackageRepository shown in the video features sample Packages (i.e. `simple-app.corp.com`).

However, changing this to showcase a repository with more meaningful Packages (e.g. [cert-manager](https://cert-manager.io/docs/)) would help users better understand kapp-controller. Using the simple-app Package isn't the perfect illustration of kapp-controller's capabilities.

The [asciinema video](https://github.com/vmware-tanzu/carvel/tree/develop/asciinema) is maintained here in the carvel repo. There should also be some discussion about what PackageRepository to use in the video.

Contributor guide

Open the contributing guide

Research direction

Start in the asciinema directory and inspect the video used on the kapp-controller webpage at the examples section. Review the current PackageRepository and its sample Packages, then determine which more meaningful repository to showcase, such as cert-manager. Done means the video and its webpage presentation use the agreed realistic PackageRepository.

Written by the indexing model from the issue text.

Assessment

Domain
content, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.