| runme | ||||
|---|---|---|---|---|
|
...to the Intro to Runnable Docs with Runme & Stateful.
curl -s https://media.graphassets.com/8npLBOUJT7K3i1AksnVj- I'm Sebastian Huckleberry (formerly Tiedtke; just got married 💒)
- Co-founder & CTO at Stateful.
- Grew up outside of Munich in Germany 🇩🇪
- Relocated to the USA 🇺🇸 ~15y ago to work at startups (Sauce Labs & Smallstep)
Today we'll talk about how to levarage runnable docs to:
- Platform customers/teams to operate self-service
- Customer/team solution hand-off
- Supporting escalations & incident response
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.
const sharp = require('sharp'), https = require('https'), ratio = process.env.IMG_RATIO || 0.1;
const w = Math.round(9535 * ratio), h = Math.round(8004 * ratio);
https.get('https://runme.dev/runme_cube.svg', (response) => {
let data = '';
response.on('data', (chunk) => data += chunk);
response.on('end', () => sharp(Buffer.from(data)).resize(w, h).toBuffer().then(resized => process.stdout.write(resized)));
});Change the ratio with the cell below and rerun the previous cell to see its effect.
export IMG_RATIO=Enter the ratio of the image, e.g. 0.04
echo "IMG_RATIO=${IMG_RATIO}"Enough said, let's dive right in!
This demo depends on the excellent devcontainer infra provided by https://github.com/ContainerCraft and their respective OSS licenses:
This repo is license under Apache 2.0. The full license is right here:
cat LICENSE