Skip to content

Commit

Permalink
More edits
Browse files Browse the repository at this point in the history
  • Loading branch information
sourishkrout committed Oct 9, 2024
1 parent 3b5cf50 commit 0804004
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 11 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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;
Expand All @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/0_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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).
14 changes: 10 additions & 4 deletions docs/3_teardown.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -23,12 +27,14 @@ 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
```

```sh {"id":"01J9Q4ZDKSY6W5FRJNPAJMY7P3","name":"uninstall-emojivoto"}
kubectl delete -f emojivoto.yml
```

## Done! πŸ‘
## Easy, right? πŸ‘

Almost time for [Q&A](4_thankyou.md).
17 changes: 17 additions & 0 deletions docs/4_thankyou.md
Original file line number Diff line number Diff line change
@@ -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"
```

0 comments on commit 0804004

Please sign in to comment.