🎦 One asciinema per feature 🎭

[adriens]

❔ Context

yamlfixer has a pretty decent set of one-purpose features that need to be showcased to be better known used... and then provide an easy way to discover how to use this tool and what can be achieved with it.

Therefore, it would be very useful to get an asciinema per feature so we can share them in beautiful demos accross social medias.

🎯 Target

• Better knwoledge of all features

💰 Gains

• Animate community with nice and useful content

⚠️ Risks

What are the risks if we don't implement this issue.

Not having visual content to show how easy it is to achieve nice tings with yamlfixer.

📑 Actions

• Create an asciinema that show how install and fix a bad yaml file, and show diff before/after #65
• Create an asciinema for --backup and the --backupsuffix option cf Feature request > Customize backup files suffix pattern #71
• Create an asciinema for --listfixes
• Create an asciinema for --jsonsummary
• Create an asciinema for --plainsummary
• Create an asciinema for --summary
• Create an asciinema that shows how to pipe and query with jq
• Create an asciinema that show how to plug engine template

Demo Protocol

Not recording in the session

1️⃣ First uninstall

To make things look fresh :

python3 -m pip uninstall yamlfixer-opt-nc

2️⃣ 🎥 Record in the session :

python3 -m pip install yamlfixer-opt-nc
export PATH=$PATH:~/.local/bin

yamlfixer --version
yamlfixer --help

git clone https://github.com/opt-nc/yamlfixer.git
cd yamlfixer

# The featur you want to demonstrate
# yamlfixer --summary --backupsuffix .bak --backup examples/*.yml
# ls -ltr examples/*
# icdiff examples/bad.yml.bak examples/bad.yml