From b0b5d9e6030c5093db2679ff088e29b03f9e2c88 Mon Sep 17 00:00:00 2001
From: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Date: Wed, 27 Mar 2024 17:36:59 +0100
Subject: [PATCH] chore: add asciinema guidelines
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
---
content/contribute/components/videos.md | 26 +++++++++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/content/contribute/components/videos.md b/content/contribute/components/videos.md
index 5edb91d8bb..55bb505447 100644
--- a/content/contribute/components/videos.md
+++ b/content/contribute/components/videos.md
@@ -4,6 +4,8 @@ title: Videos
toc_max: 3
---
+## iframe
+
To embed a video on a docs page, use an `
```
+
+## asciinema
+
+`asciinema` is a command line tool for recording terminal sessions. The
+recordings can be embedded on the documentation site. These are similar to
+`console` code blocks, but since they're playable and scrubbable videos, they
+add another level of usefulness over static codeblocks in some cases. Text in
+an `asciinema` "video" can also be copied, which makes them more useful.
+
+Consider using an `asciinema` recording if:
+
+- The input/output of the terminal commands are too long for a static example
+ (you could also consider truncating the output)
+- The steps you want to show are easily demonstrated in a few commands
+- Where the it's useful to see both inputs and outputs of commands
+
+To create an `asciinema` recording and add it to docs:
+
+1. [Install](https://docs.asciinema.org/getting-started/) the `asciinema` CLI
+2. Run `asciinema auth` to configure your client and create an account
+3. Start a new recording with `asciinema rec`
+4. Run the commands for your demo and stop the recording with `` or `exit`
+5. Upload the recording to
+6. Embed the player with a `