Skip to content

Commit 27bd668

Browse files
committed
docs: update gifs #18
1 parent 4ef3c90 commit 27bd668

8 files changed

+191
-6
lines changed

Makefile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,13 @@ help: ## Prints help for targets with comments
44
test: ## Run tests
55
@nvim --headless --noplugin -u ./tests/init.lua -c "lua MiniTest.run()"
66

7+
gif: ## Create gifs
8+
vhs ./doc/tapes/kustomize.nvim-build.tape
9+
vhs ./doc/tapes/kustomize.nvim-deprecations.tape
10+
vhs ./doc/tapes/kustomize.nvim-kinds.tape
11+
vhs ./doc/tapes/kustomize.nvim-open.tape
12+
vhs ./doc/tapes/kustomize.nvim-print.tape
13+
vhs ./doc/tapes/kustomize.nvim-validate.tape
14+
715
clean: ## Delete .tests/ (test config for Neovim instance)
816
@rm -fr .tests

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ With Lazy.nvim for instance:
103103
<details>
104104
<summary>Showcase</summary
105105
106-
![kustomize.nvim-build.gif](https://s1.gifyu.com/images/kustomize.nvim-build.gif)
106+
[![kustomize.nvim-build.gif](https://s12.gifyu.com/images/kustomize.nvim-build.gif)](https://gifyu.com/image/SlSXE)
107107
108108
</details>
109109

@@ -115,7 +115,7 @@ This allows me to quickly inspect the YAML that Kustomize generates (and ultimat
115115
<details>
116116
<summary>Showcase</summary
117117
118-
![kustomize.nvim-kinds.gif](https://s4.gifyu.com/images/kustomize.nvim-kinds.gif)
118+
![kustomize.nvim-kinds.gif](https://s12.gifyu.com/images/kustomize.nvim-kinds.gif)
119119
120120
</details>
121121

@@ -126,8 +126,7 @@ Sometimes, I just want to roughly check the YAMLs generated by Kustomize. A good
126126
<details>
127127
<summary>Showcase</summary
128128
129-
TODO: update gif to illustrate new quickfix list feature
130-
![kustomize.nvim-open.gif](https://s4.gifyu.com/images/kustomize.nvim-open.gif)
129+
![kustomize.nvim-open.gif](https://s12.gifyu.com/images/kustomize.nvim-open.gif)
131130
132131
</details>
133132

@@ -150,7 +149,7 @@ In order to quickly check/edit those included YAMLs this command will go through
150149
<details>
151150
<summary>Showcase</summary
152151

153-
[![kustomize.nvim-resources.gif](https://s4.gifyu.com/images/kustomize.nvim-resources.gif)](https://gifyu.com/image/ShTyF)
152+
![kustomize.nvim-print.gif](https://s12.gifyu.com/images/kustomize.nvim-print.gif)
154153

155154
</details>
156155

@@ -161,7 +160,7 @@ When writing a new deployment I usually split the resources into files according
161160
<details>
162161
<summary>Showcase</summary
163162

164-
[![kustomize.nvim-validate.gif](https://s1.gifyu.com/images/kustomize.nvim-validate.gif)](https://gifyu.com/image/ShQmx)
163+
![kustomize.nvim-validate.gif](https://s12.gifyu.com/images/kustomize.nvim-validate.gif)
165164

166165
</details>
167166

doc/tapes/kustomize.nvim-build.tape

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Output kustomize.nvim-build.gif
2+
3+
Set WindowBar Colorful
4+
Set Padding 5
5+
6+
Set FontSize 16
7+
Set Width 1200
8+
Set Height 700
9+
10+
Sleep 1s
11+
Type@100ms "nvim ~/workspace/github.com/allaman/kustomize-demo/basic/overlay/dev/kustomization.yaml"
12+
Sleep 1s
13+
Enter
14+
Sleep 1s
15+
Type@300ms ":KustomizeBuild"
16+
Sleep 2s
17+
Enter
18+
Sleep 2s
19+
Ctrl+d
20+
Sleep 2s
21+
Ctrl+d
22+
Sleep 2s
23+
Ctrl+d
24+
Sleep 2s
25+
Ctrl+d
26+
Sleep 2s
27+
Ctrl+d
28+
Sleep 2s
29+
Type "q"
30+
Sleep 2s
31+
Hide
32+
Type ":q"
33+
Enter
34+
Sleep 2s
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Output kustomize.nvim-deprecations.gif
2+
3+
Set WindowBar Colorful
4+
Set Padding 5
5+
6+
Set FontSize 16
7+
Set Width 1200
8+
Set Height 700
9+
10+
Sleep 1s
11+
Type@100ms "nvim ~/workspace/github.com/allaman/kustomize-demo/advanced/base/ingress.yaml"
12+
Sleep 1s
13+
Enter
14+
Sleep 1s
15+
Type@300ms ":KustomizeDeprecations"
16+
Enter
17+
Sleep 3s
18+
Hide
19+
Type ":NoiceDismiss"
20+
Enter
21+
Show
22+
Type@300ms "ggjAbeta1"
23+
Escape
24+
Type ":w"
25+
Enter
26+
Sleep 5s
27+
Type@300ms ":KustomizeDeprecations"
28+
Enter
29+
Sleep 5s
30+
Hide
31+
Type "u:wq"
32+
Enter
33+
Show
34+
Sleep 2s

doc/tapes/kustomize.nvim-kinds.tape

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Output kustomize.nvim-kinds.gif
2+
3+
Set WindowBar Colorful
4+
Set Padding 5
5+
6+
Set FontSize 16
7+
Set Width 1200
8+
Set Height 700
9+
10+
Sleep 1s
11+
Type@100ms "nvim ~/workspace/github.com/allaman/kustomize-demo/basic/overlay/dev/kustomization.yaml"
12+
Sleep 1s
13+
Enter
14+
Sleep 1s
15+
Type@300ms ":KustomizeBuild"
16+
Enter
17+
Sleep 2s
18+
Type@300ms ":KustomizeListKinds"
19+
Enter
20+
Sleep 2s
21+
Type@3s "jjjkkk"
22+
Type "q"
23+
Sleep 1s
24+
Type "q"
25+
Sleep 2s
26+
Hide
27+
Type ":q"
28+
Enter
29+
Show
30+
Sleep 2s

doc/tapes/kustomize.nvim-open.tape

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Output kustomize.nvim-open.gif
2+
3+
Set WindowBar Colorful
4+
Set Padding 5
5+
6+
Set FontSize 16
7+
Set Width 1200
8+
Set Height 700
9+
10+
Sleep 1s
11+
Type@100ms "nvim ~/workspace/github.com/allaman/kustomize-demo/basic/base/bar/kustomization.yaml"
12+
Sleep 1s
13+
Enter
14+
Sleep 1s
15+
Type@300ms ":KustomizeListResources"
16+
Enter
17+
Sleep 2s
18+
Type@3s "jjjkkk"
19+
Type "q"
20+
Sleep 2s
21+
Hide
22+
Type ":q"
23+
Enter
24+
Show
25+
Sleep 2s

doc/tapes/kustomize.nvim-print.tape

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Output kustomize.nvim-print.gif
2+
3+
Set WindowBar Colorful
4+
Set Padding 5
5+
6+
Set FontSize 16
7+
Set Width 1200
8+
Set Height 700
9+
10+
Sleep 1s
11+
Type@100ms "nvim ~/workspace/github.com/allaman/kustomize-demo/basic/base/bar/kustomization.yaml"
12+
Sleep 1s
13+
Enter
14+
Sleep 1s
15+
Type G
16+
Sleep 0.5s
17+
Type@500ms Vkkd
18+
Sleep 1s
19+
Type@300ms ":KustomizePrintResources"
20+
Enter
21+
Sleep 4s
22+
Type@700ms jjjkk
23+
Sleep 2s
24+
Hide
25+
Type ":q!"
26+
Enter
27+
Show
28+
Sleep 2s
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Output kustomize.nvim-validate.gif
2+
3+
Set WindowBar Colorful
4+
Set Padding 5
5+
6+
Set FontSize 16
7+
Set Width 1200
8+
Set Height 700
9+
10+
Sleep 1s
11+
Type@100ms "nvim ~/workspace/github.com/allaman/kustomize-demo/basic/base/bar/service.yaml"
12+
Sleep 1s
13+
Enter
14+
Sleep 1s
15+
Type@300ms ":KustomizeValidate"
16+
Enter
17+
Sleep 2s
18+
Type "ggjjdd:w"
19+
Enter
20+
Type@300ms ":KustomizeValidate"
21+
Enter
22+
Sleep 5s
23+
Hide
24+
Type "u:wq"
25+
Enter
26+
Show
27+
Sleep 2s

0 commit comments

Comments
 (0)