yamlfixer
yamlfixer copied to clipboard
:cinema: One asciinema per feature :performing_arts:
❔ 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.
:bookmark_tabs: Actions
- [ ] #65
- [x] #71
- [ ] Create an
asciinemafor--listfixes - [ ] Create an
asciinemafor--jsonsummary - [ ] Create an
asciinemafor--plainsummary - [ ] Create an
asciinemafor--summary - [ ] Create an
asciinemathat shows how to pipe and query withjq - [ ] Create an
asciinemathat show how to plug engine template
Demo Protocol
Not recording in the session
:one: First uninstall
To make things look fresh :
python3 -m pip uninstall yamlfixer-opt-nc
:two: :movie_camera: 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