From 08040040064a5fd10f3867939e59f0a556888aa6 Mon Sep 17 00:00:00 2001 From: Sebastian Tiedtke Date: Tue, 8 Oct 2024 20:29:00 -0700 Subject: [PATCH] More edits --- README.md | 23 ++++++++++++++++++----- docs/0_intro.md | 4 ++-- docs/3_teardown.md | 14 ++++++++++---- docs/4_thankyou.md | 17 +++++++++++++++++ 4 files changed, 47 insertions(+), 11 deletions(-) create mode 100644 docs/4_thankyou.md diff --git a/README.md b/README.md index 5b00616..73d776d 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ runme: ...to the Intro to Runnable Docs with Runme & Stateful. -```bash {"id":"01J9PKTCCF1X9NKG7N64SVWDJ4","interactive":"false"} +```sh {"id":"01J9PKTCCF1X9NKG7N64SVWDJ4","interactive":"false"} curl -s https://media.graphassets.com/8npLBOUJT7K3i1AksnVj ``` @@ -25,7 +25,20 @@ Today we'll talk about how to levarage runnable docs to: - Customer/team solution hand-off - Supporting escalations & incident response -To me this possible, we have created the open source toolchain called [Runme](https://runme.dev). +## Why is this so hard ⛓️‍💥? + +#### It's 2024... and docs are still **always** broken + +```sh {"id":"01J9QKC740F5YY7WPVGCC7JRQD","interactive":"false"} +curl -Ls https://steemitimages.com/0x0/https://media1.giphy.com/media/F7yLXA5fJ5sLC/giphy.gif +``` + +- Fault lines between tooling: editor, terminal, browser, and cloud consoles +- Disconnect between authoring, reading, running docs: often wrong the moment they are written +- Even if docs are "correct", we often don't realize they are couple with unreproducible environments +- Docs are a side-show, copy&paste at best, never how work actually gets done + +### To solve this problem, we have created the open source toolchain called [Runme](https://runme.dev). ```javascript {"id":"01J9PP34RXT5C0470PABM5AC5T","interactive":"false"} const sharp = require('sharp'), https = require('https'), ratio = process.env.IMG_RATIO || 0.1; @@ -37,14 +50,14 @@ https.get('https://runme.dev/runme_cube.svg', (response) => { }); ``` -## Ohai large Runme logo +## Ohai large ▶️ Runme logo -```bash {"id":"01J9PTV1YKNA83TESRZ18WC90D","promptEnv":"yes","terminalRows":"3"} +```sh {"id":"01J9PTV1YKNA83TESRZ18WC90D","promptEnv":"yes","terminalRows":"3"} export IMG_RATIO="Enter the ratio of the image, e.g. 0.04" echo "IMG_RATIO=${IMG_RATIO}" ``` -Let's [dive right in](docs/0_intro.md)! +Enough said, let's [dive right in](docs/0_intro.md)! ## Licensing diff --git a/docs/0_intro.md b/docs/0_intro.md index 1dcd14d..a826ef6 100644 --- a/docs/0_intro.md +++ b/docs/0_intro.md @@ -14,7 +14,7 @@ Borrows from Jupyter but accounts for developers and operators splitting time be ![Architecture](images/arch.png) -## Just Markdown +## It's just Markdown 💡 - Runme parsers and saved markdown files - One person, everyone, or a few team members can use Runme @@ -108,4 +108,4 @@ $ bq query --format json --use_legacy_sql=false $QUERY 2> /dev/null | jq . ## Into the Cloud ☁️ -Now that we explored the basics, let's see how Runme can help us [in the cloud](1_aws.md). +Now that we explored the basics, let's see how Runme can help us in [the cloud™️](1_aws.md). diff --git a/docs/3_teardown.md b/docs/3_teardown.md index 52206de..e936543 100644 --- a/docs/3_teardown.md +++ b/docs/3_teardown.md @@ -6,9 +6,13 @@ runme: terminalRows: 20 --- -## Teardown +## Cleaning up -Get back into the original state, a good idea for cloud cost savings. +Get back into the original state. Be careful, the cloud's expensive. + +```sh {"id":"01J9QM5PP29W5FEQ4QGXKWJSFB","interactive":"false"} +curl -s https://media.tenor.com/0iYQvzqlwxwAAAAM/very-expensive-hoffman-and-turk-attorney.gif +``` Free the forwarded port @@ -23,7 +27,7 @@ Make sure the right cluster is selected kubectl config get-contexts ``` -```sh {"background":"true","id":"01HR5TEYQK0K2BF014JQB06V0A","name":"watch-emojivoto-ns","terminalRows":"18"} +```sh {"background":"false","id":"01HR5TEYQK0K2BF014JQB06V0A","name":"pods-emojivoto-ns","terminalRows":"18"} kubectl get pods -n emojivoto ``` @@ -31,4 +35,6 @@ kubectl get pods -n emojivoto kubectl delete -f emojivoto.yml ``` -## Done! 👏 +## Easy, right? 👏 + +Almost time for [Q&A](4_thankyou.md). diff --git a/docs/4_thankyou.md b/docs/4_thankyou.md new file mode 100644 index 0000000..d3bb4f5 --- /dev/null +++ b/docs/4_thankyou.md @@ -0,0 +1,17 @@ +--- +cwd: .. +--- + +# Vielen Dank 🙏 + +I'm happy to answer any questions in either language, English or German. + +Be sure to join our Discord at [discord.gg/runme](https://discord.gg/runme) if you need support. + +## Try it Now 🚀 + +It's open source and free. Scan the QR code below to get started with [docs.runme.dev](https://docs.runme.dev). + +```sh {"id":"01J9QMGG2SGAVF9069T11C44YH","interactive":"false"} +curl -s "https://api.qrserver.com/v1/create-qr-code/?data=https%3A%2F%2Fdocs.runme.dev&size=300x300" +```