diff --git a/.runme/owl.yaml b/.runme/owl.yaml index b27ba289..3e53fcfb 100644 --- a/.runme/owl.yaml +++ b/.runme/owl.yaml @@ -4,7 +4,7 @@ metadata: name: docs.runme.dev namespace: stateful annotations: - github.com/repo-url: https://github.com/stateful/docs.runme.dev + github.com/repo-url: https://github.com/runmedev/docs.runme.dev spec: type: owl envSpecs: @@ -34,7 +34,7 @@ metadata: name: docs.runme.dev namespace: stateful annotations: - github.com/repo-url: https://github.com/stateful/docs.runme.dev + github.com/repo-url: https://github.com/runmedev/docs.runme.dev spec: type: owl path: diff --git a/dagger/README.md b/dagger/README.md index cab4266b..8a238240 100644 --- a/dagger/README.md +++ b/dagger/README.md @@ -1,55 +1,44 @@ --- cwd: .. -runme: - id: 01JBWW23ENADYZXX5KFGME12KR - version: v3 +shell: dagger shell terminalRows: 20 --- -# The Docs, daggerized - -See what functions are available in the `docs` module, and how to use them. +# The Docs, daggerized with Dagger Shell If you're running this example for the first time, please complete the steps in [prerequisites](SETUP.md) first. > 💡 Be sure to switch to the pre-release version of the Runme extension to see the `Env Store` tab. [Here](https://docs.runme.dev/installation/vscode#bleeding-edge-features) is how. -```sh {"id":"01JBW9KGZT5XE4B0G1Z8GK1239","terminalRows":"8"} -dagger functions -``` - -Inspect a local instance of the docs before deploying it to the cloud. +Let's define local site as the local host's root directory of the docs site. Mainly for clarity. -```sh {"background":"true","id":"01JBWGTT8R91VNCV1JSG8KF1K5","name":"serve-locally"} -dagger call --site . \ - serve \ - up +```sh {"name":"LocalSite","terminalRows":"11"} +### Exported in runme.dev as LocalSite +host | directory "." ``` -## Deploy a docs site preview +See what functions are available in the `docs` module, and how to use them. -```sh {"id":"01JBWVFDXVDBBMRQAQA61NN6CB","name":"deploy-where","terminalRows":"3"} -echo "Deploying preview into \"${DOCS_GCP_PROJECT_ID}\" in \"${DOCS_GCP_REGION}\" via artifacts repo \"${DOCS_GCP_ARTIFACTS_REPO}\"." +```sh {"terminalRows":"15"} +. $(LocalSite) | .help ``` -This will deploy a preview of the docs site to the cloud. +Inspect a local instance of the docs before deploying it to the cloud. -```sh {"background":"false","id":"01JBWA2741XJE0KZZTGP7P1WKB","name":"DEPLOY_URL"} -dagger call --site . \ - deploy \ - --project="${DOCS_GCP_PROJECT_ID}" \ - --region="${DOCS_GCP_REGION}" \ - --repo="${DOCS_GCP_ARTIFACTS_REPO}" \ - --credentials="env:DOCS_GCP_CREDENTIALS" +```sh {"background":"true","name":"LocalService"} +### Exported in runme.dev as LocalService +. $(LocalSite) | serve | up --random=true ``` -```sh {"id":"01JBWV44M5ZJCAERKS9E5KP7RS","interactive":"true","terminalRows":"5"} -echo "Opening ${DEPLOY_URL}" -open ${DEPLOY_URL} +## Deploy a docs site preview + +```sh {"interpreter":"bash","terminalRows":"3"} +echo "Deploying preview into \"${DOCS_GCP_PROJECT_ID}\" in \"${DOCS_GCP_REGION}\" via artifacts repo \"${DOCS_GCP_ARTIFACTS_REPO}\"." ``` -## See what services are running +This will deploy a preview of the docs site to the cloud. The last positional argument has no leading `$` because it's a secret. -```sh {"id":"01JBX0HGR3DBKSC6PJM57845EK"} -https://console.cloud.google.com/run?project=${DOCS_GCP_PROJECT_ID} +```sh {"background":"false","name":"PreviewSite"} +### Exported in runme.dev as PreviewSite +. $(LocalSite) | deploy $DOCS_GCP_PROJECT_ID $DOCS_GCP_REGION $DOCS_GCP_ARTIFACTS_REPO DOCS_GCP_CREDENTIALS ``` diff --git a/docs/configuration/cell-level.md b/docs/configuration/cell-level.md index 2228e6c3..75e0dce4 100644 --- a/docs/configuration/cell-level.md +++ b/docs/configuration/cell-level.md @@ -89,7 +89,7 @@ Your VS Code view will split into two. One side has Notebook view, and the other -Take a look at more [examples](https://github.com/stateful/vscode-runme/tree/main/examples) available inside the VS Code extension repo for a reference on how to apply these code block attributes in different use cases! +Take a look at more [examples](https://github.com/runmedev/vscode-runme/tree/main/examples) available inside the VS Code extension repo for a reference on how to apply these code block attributes in different use cases! @@ -183,7 +183,7 @@ openssl rand -base64 32 If a cell has exported variables, the user will be prompted to set these variables. This can be useful to have a parameterized cell while not needing to manually modify the cell. Following modes are available: -| Mode | Description | +| Mode | Description | | -------------- | ----------------------------------------------------------------------------------------------------- | | auto [default] | Prompt when environment variable has no value (e.g. loaded from .env). | | always / yes | Always prompt allow for environment variable. Use existing value as placeholder if present. | @@ -333,7 +333,7 @@ echo "hello world" -Take a look at more [examples](https://github.com/stateful/vscode-runme/tree/main/examples) available inside the VS Code extension repo for a reference on how to apply these code block attributes in different use cases! +Take a look at more [examples](https://github.com/runmedev/vscode-runme/tree/main/examples) available inside the VS Code extension repo for a reference on how to apply these code block attributes in different use cases! diff --git a/docs/getting-started/vscode.md b/docs/getting-started/vscode.md index 70d73c08..0fd9d50e 100644 --- a/docs/getting-started/vscode.md +++ b/docs/getting-started/vscode.md @@ -223,4 +223,4 @@ We believe, at this point, you have gotten an advanced understanding of how Runm We have provided an [FAQ page](/resources/faq), which we constantly update to address common questions you may have about Runme. -If you run into any issues kindly [file a ticket](https://github.com/stateful/runme/issues) or tell us about it [on Discord](https://discord.gg/runme). We are open to hearing your suggestions on how we can improve Runme. +If you run into any issues kindly [file a ticket](https://github.com/runmedev/runme/issues) or tell us about it [on Discord](https://discord.gg/runme). We are open to hearing your suggestions on how we can improve Runme. diff --git a/docs/guide/bigquery.md b/docs/guide/bigquery.md index 35014e69..6074382c 100644 --- a/docs/guide/bigquery.md +++ b/docs/guide/bigquery.md @@ -262,4 +262,4 @@ bq --help ## Feedback -You have successfully set up and configured Google BigQuery and executed SQL queries on BigQuery within your Runme notebook. We are constantly developing more features for Runme. If you have feedback on this or new ideas for improving this feature, feel free to [contact us](https://github.com/stateful/runme?tab=readme-ov-file#feedback). +You have successfully set up and configured Google BigQuery and executed SQL queries on BigQuery within your Runme notebook. We are constantly developing more features for Runme. If you have feedback on this or new ideas for improving this feature, feel free to [contact us](https://github.com/runmedev/runme?tab=readme-ov-file#feedback). diff --git a/docs/guide/cloud-render/aws.md b/docs/guide/cloud-render/aws.md index f4c13547..3b52a8e1 100644 --- a/docs/guide/cloud-render/aws.md +++ b/docs/guide/cloud-render/aws.md @@ -243,4 +243,4 @@ If you would love to navigate to the AWS console for that cluster, click the vie ## Feedback and Contribution -We are still developing more features for the Runme Cloud Renderers. If you have feedback on this or new ideas on how to improve this feature, feel free to [reach out to us](https://github.com/stateful/runme?tab=readme-ov-file#feedback). +We are still developing more features for the Runme Cloud Renderers. If you have feedback on this or new ideas on how to improve this feature, feel free to [reach out to us](https://github.com/runmedev/runme?tab=readme-ov-file#feedback). diff --git a/docs/guide/cloud-render/cloud-run.md b/docs/guide/cloud-render/cloud-run.md index b8bf76c5..69270705 100644 --- a/docs/guide/cloud-render/cloud-run.md +++ b/docs/guide/cloud-render/cloud-run.md @@ -20,7 +20,7 @@ Check out our detailed installation guide for instructions on [installing Runme - **Change directory** -The next step is to navigate into your directory. However, if you do not have an existing folder you would love to work on, you can create a new folder or [clone the repo](https://github.com/stateful/vscode-runme/blob/main/examples/gcp/cloudRun.md) you want to work with. +The next step is to navigate into your directory. However, if you do not have an existing folder you would love to work on, you can create a new folder or [clone the repo](https://github.com/runmedev/vscode-runme/blob/main/examples/gcp/cloudRun.md) you want to work with. To create a folder, run the command below @@ -153,7 +153,7 @@ This will add a new code block that automatically downloads your YAML configurat ## Feedback and Contribution -We are still developing more features for the Runme Notebook Cloud Renderers. If you have feedback on this or new ideas on how to improve this feature, feel free to [reach out to us](https://github.com/stateful/runme?tab=readme-ov-file#feedback). +We are still developing more features for the Runme Notebook Cloud Renderers. If you have feedback on this or new ideas on how to improve this feature, feel free to [reach out to us](https://github.com/runmedev/runme?tab=readme-ov-file#feedback). ## Additional Resources diff --git a/docs/guide/cloud-render/gcp.md b/docs/guide/cloud-render/gcp.md index 8099ffe4..71519a45 100644 --- a/docs/guide/cloud-render/gcp.md +++ b/docs/guide/cloud-render/gcp.md @@ -204,4 +204,4 @@ When this runs, the details dashboard of your cluster will be displayed. ## Feedback and Contribution -We are still developing more features for the Runme Cloud Renderers. If you have feedback on this or new ideas on how to improve this feature, feel free to [reach out to us](https://github.com/stateful/runme?tab=readme-ov-file#feedback). +We are still developing more features for the Runme Cloud Renderers. If you have feedback on this or new ideas on how to improve this feature, feel free to [reach out to us](https://github.com/runmedev/runme?tab=readme-ov-file#feedback). diff --git a/docs/guide/dagger.md b/docs/guide/dagger.md index f4e2b436..b5d04945 100644 --- a/docs/guide/dagger.md +++ b/docs/guide/dagger.md @@ -1,14 +1,32 @@ --- sidebar_position: 5 +title: Dagger --- -# Dagger - -In this guide, we will explain step-by-step how to integrate Dagger into Runme and how it works. +# Runme for Dagger + +In this guide, we will explain step-by-step how to leverage both Dagger Shell and "Dagger Call" integrations into Runme and how it works. + +
+ +
+ ➡️ Runme for Dagger in Action +
+
+
## Getting Started -To proceed with this guide, it is crucial to carry out the following actions: +To proceed with this guide, it is crucial to install Dagger first: - **Install Runme** @@ -22,26 +40,107 @@ Get Docker installed and running on your local machine. You can download Docker Install Dagger on your local machine. The [Dagger installation guide](https://docs.dagger.io/install/) provides more information on how to install Dagger on any platform of your choice. if you have brew installed already run the command below to install dagger -```sh {"id":"01J6CH26D7HCJXVZXA2CATX4A2"} +```sh brew install dagger/tap/dagger ``` -## Navigating the Dagger CLI Using Runme Notebooks +## Dagger Shell with ".dag" Notebooks + +Dagger shell is the latest interface for interacting with Dagger. If you're looking for `dagger call`, please see futher down in this guide. While it's up to personal preference, we recommend using Dagger Shell to express your Dagger pipelines. Its syntax is more concise and easier to read. For a complete introduction to Dagger shell, please visit the [Dagger docs](https://docs.dagger.io/). + +Of course, Runme can always bring up an instance of Dagger shell using the following command. This will drop you into a REPL prompt interface interface. + +```sh +$ dagger shell +``` + +### Your first Dagger Shell notebook + +While a shell session is great during interactive development, Runme notebooks excel at expressing Dagger pipelines in a self-documenting manner. This is useful to document tasks, workflows, onboarding instructions, or the beaten path of your Dagger pipelines. + +There are two ways to get started with the native integration with Dagger shell: + +1. Add `dagger shell` as interpreter in your [cell configuration](https://docs.runme.dev/configuration/cell-level#cell-configuration-keys) or globally in the notebook document's [frontmatter](https://docs.runme.dev/configuration/document-level). +2. Or, create a new `my-notebook.dag` notebook file (in the Runme Extension) in your project which will auto-set the document's frontmatter to use `dagger shell` as the interpreter. + +> 💡 Note that the `.dag` is interchangeable with `.md` and both will render to Markdown. The `.dag` extension is simply a signal to the Runme extension to bootstrap the document with the Dagger shell interpreter. + +![dagger shell in frontamtter](/img/integration/runme-dagger-shell-frontmatter.png) + +### Running Dagger Shell-native in Notebook Cells + +Here's a quick rundown how to run a Dagger Module via the Dagger Shell inside a cell. For a end-to-end example, please see [README.md](https://github.com/runmedev/docs.runme.dev/blob/main/dagger/README.md). + +Following simple snippet will build the runme binary for tag v3.12.2 and export it to a temporary file. While the language is Dagger shell, the syntax is standard shell compatible. Much like how `bash` or `zsh` are just `sh`. + +```sh {"interpreter":"dagger shell","name":"RunmeBinary","terminalRows":"16"} +github.com/purpleclay/daggerverse/golang $(git https://github.com/runmedev/runme | tag v3.12.2 | tree) | + build --arch arm64 --os darwin | + file runme | + export /tmp/runme_binary +``` + +Running the above snippet will produce the following output and drop a binary at `/tmp/runme_binary`. + +![build runme binary via dagger shell](/img/integration/runme-dagger-shell-snippet.png) + +### Run the same cell with Runme CLI + +In case where opening the notebook interface is not ideal, you can run the same cell with the Runme CLI by running the following command: + +```sh +$ runme run RunmeBinary +``` -Dagger CLI is the core tool used to interact with Dagger’s functions. You can chain commands and build entire DevOps pipelines by calling dagger functions from the CLI. +![build runme binary via named cell](/img/integration/runme-dagger-shell-named.png) + +### Compose Pipelines Chaining Cells + +Shell expression syntax in Dagger Shell allows you to chain cells together. This is useful when you want to build more complex pipelines. The ability to build pipelines incrementally or build individual artifacts in isolation is a powerful feature for development, troubleshooting, and testing. + +```sh {"interpreter":"dagger shell","name":"RunmeVersion"} +# Exported as "RunmeVersion" +git https://github.com/runmedev/runme | tag v3.12.2 | tree +``` + +This exports a reference to Runme's git repository at the tag `v3.12.2` under `RunmeVersion`. In turn, this reference can be used with a shell expression to build the runme binary in separate cell. + +```sh {"interpreter":"dagger shell","name":"RunmeBinary"} +# Exported as "RunmeBinary" +github.com/purpleclay/daggerverse/golang $(RunmeVersion) | + build | + file runme | + export /tmp/runme_binary +``` + +Running the `RunmeBinary` cell in the notebook or the Runme CLI will produce the following output and drop a Runme binary at `/tmp/runme_binary`. + +![build runme binary referencing the version](/img/integration/runme-dagger-shell-reference.png) + +To make the reference names clear, Runme will automatically add comments to a cell's markdown representation. + +![dagger shell cells exported with names](/img/integration/runme-dagger-shell-reference-comment.png) + +This allows pipelines to be expressed incrementally, cell-by-cell, and still be clear, readable, and most of all, executable across notebooks, editor, and the CLI. + +Please check out the Runme Extension's [shell.dag](https://github.com/runmedev/vscode-runme/blob/main/dagger/notebook/shell.dag) for a more comprehensive example. + +## Alternative Interface: "dagger call" + +Dagger CLI is an alternative core interface used to interact with Dagger’s functions. You can chain commands and build entire DevOps pipelines by calling dagger functions from the CLI. While we do recommend using Dagger Shell, this CLI interface is still useful. This section will explore navigating the Dagger CLI in your Runme Notebooks. We will explain how it works in detail. -### Writing Dagger Module within Runme Notebook cell +### Calling Dagger Modules within Runme Notebook cell Runme Notebook interface includes a terminal environment with [additional features](/getting-started/vscode#interactive-mode), that gives you the experience of working in your regular terminal and more. With the Runme Notebook interface, you can write and execute Dagger commands. Let’s explore the code block below. -```sh {"id":"01J5TMAKC9QEMWB806SC1V5WH9"} +```sh dagger call \ -m github.com/purpleclay/daggerverse/golang@v0.3.0 \ - --src "https://github.com/stateful/runme#main" \ + --src "https://github.com/runmedev/runme#main" \ build \ --arch $(go env GOARCH) \ --os $(go env GOOS) \ @@ -57,7 +156,7 @@ Output: This output shows the steps executed by Dagger, which successfully performed the tasks in the code block. -### Runme Interactive CLI Support +### Run with Runme CLI Runme offers additional support for the Dagger CLI by providing options and support based on the context of your current task. @@ -67,10 +166,10 @@ When you insert a Dagger command into a Runme cell, Runme automatically provides To retrieve the file's name, click on `Name`. A code block similar to the one below will be created and automatically run to display the file's name. -```sh {"id":"01J5TMAKC9QEMWB806SD1HE7V2"} +```sh dagger call \ -m github.com/purpleclay/daggerverse/golang@v0.3.0 \ - --src "https://github.com/stateful/runme#main" \ + --src "https://github.com/runmedev/runme#main" \ build \ --arch $(go env GOARCH) \ --os $(go env GOOS) \ @@ -80,7 +179,7 @@ dagger call \ To get the size of your file, click on `size`. A code block similar to the one below will be created and automatically run to display the size of your file. -```sh {"id":"01J5TMAKC9QEMWB806SGS12GGQ"} +```sh dagger call --progress=$PROGRESS \ -m golang \ --src ../runme \ @@ -91,22 +190,22 @@ dagger call --progress=$PROGRESS \ To view the contents of your file, click on `content`. A code block similar to the one below will be created and automatically run to display the contents of your file. -```sh {"id":"01J6CGP8A99T2G7DAH034553Y3"} +```sh # This code block will show the contents of your specified file dagger call \ -m github.com/purpleclay/daggerverse/golang@v0.3.0 \ - --src "https://github.com/stateful/runme#main" \ + --src "https://github.com/runmedev/runme#main" \ file \ --path runme contents ``` To export your file, click on `export`. First, you will be prompted to choose where you'd like to save the file, and the file path will be displayed. After selecting the location, a code block similar to the one below will be created and automatically run to export your file. -```sh {"id":"01J6CGXQT45FJABBDFKYFE2EXW"} +```sh # This code block will export the specified file from your project dagger call \ -m github.com/purpleclay/daggerverse/golang@v0.3.0 \ - --src "https://github.com/stateful/runme#main" \ + --src "https://github.com/runmedev/runme#main" \ build \ --arch $(go env GOARCH) \ --os $(go env GOOS) \ @@ -122,9 +221,9 @@ This interactive interface makes the execution of complex pipelines easy and eli
@@ -136,9 +235,9 @@ If you have a Markdown file with your dagger pipeline commands written, you can
@@ -146,9 +245,9 @@ You can also run individual cells using the names of the cells or select them in
diff --git a/docs/guide/foyle.md b/docs/guide/foyle.md index 9f1a948c..c779d70d 100644 --- a/docs/guide/foyle.md +++ b/docs/guide/foyle.md @@ -116,8 +116,8 @@ In the image below, we are asking Foyle to describe a pod from the list of pods ## Where to go next -* For more information about Foyle check out the [Foyle documentation](https://foyle.io/docs). +- For more information about Foyle check out the [Foyle documentation](https://foyle.io/docs). ## Feedback and Contribution -If you have any tool or project you would like to see integrated with Runme, feel free to [contact us](https://github.com/stateful/runme?tab=readme-ov-file#feedback) with your idea. We will be glad to test it out. +If you have any tool or project you would like to see integrated with Runme, feel free to [contact us](https://github.com/runmedev/runme?tab=readme-ov-file#feedback) with your idea. We will be glad to test it out. diff --git a/docs/guide/pythonenv.md b/docs/guide/pythonenv.md index 9eb733b7..7ebfa4de 100644 --- a/docs/guide/pythonenv.md +++ b/docs/guide/pythonenv.md @@ -10,7 +10,7 @@ This section will walk you through creating Python virtual environments in your ## Creating a Python Virtual Environment -In this [example](https://github.com/stateful/vscode-runme/blob/main/examples/shebang.md#python-), we will create a virtual environment, activate it, and install packages of our choice into the virtual environment. To create a Python virtual environment in Runme, follow the steps below: +In this [example](https://github.com/runmedev/vscode-runme/blob/main/examples/shebang.md#python-), we will create a virtual environment, activate it, and install packages of our choice into the virtual environment. To create a Python virtual environment in Runme, follow the steps below: **Step 1**: Ensure the Runme extension is installed in your VS Code and make Runme your [default Markdown viewer](/getting-started/vscode#how-to-open-a-readme-file-as-a-markdown-file). diff --git a/docs/index.md b/docs/index.md index 2f602a09..36ccf410 100644 --- a/docs/index.md +++ b/docs/index.md @@ -24,10 +24,10 @@ Runme is Markdown compatible (and a superset), open source licensed toolchain un All the code for Runme can be found in four repositories on GitHub: -- [Kernel / CLI](https://github.com/stateful/runme) -- [VS Code extension](https://github.com/stateful/vscode-runme) -- [GitHub action](https://github.com/stateful/runme-action) -- [Docs](https://github.com/stateful/docs.runme.dev) +- [Kernel / CLI](https://github.com/runmedev/runme) +- [VS Code extension](https://github.com/runmedev/vscode-runme) +- [GitHub action](https://github.com/runmedev/runme-action) +- [Docs](https://github.com/runmedev/docs.runme.dev) ## Introduction Video diff --git a/docs/installation/cdes.md b/docs/installation/cdes.md index fc7e2974..9d1236d5 100644 --- a/docs/installation/cdes.md +++ b/docs/installation/cdes.md @@ -47,7 +47,8 @@ Gitpod is a cloud-based development environment that allows developers to launch In this section, we will walk you through how to Install Runme on Gitpod. -### Sign Up and Login* +### Sign Up and Login + The first step is to create an account and sign-in. To do this, go to the [Gitpod website](https://gitpod.io/), click on **‘Try for Free’** and sign up using your GitHub, GitLab, or Bitbucket account. Once signed up, log in to Gitpod with the account you used earlier. @@ -61,7 +62,7 @@ After completing the signup and log-in process, the next step is to create a new - Press Enter, and Gitpod will start setting up your workspace. ```sh {"id":"01J01CHB3T1KG1ZV9WT59RKDN2"} -open https://gitpod.io/#https://github.com/stateful/Runme-CDEs +open https://gitpod.io/#https://github.com/runmedev/runme-CDEs ``` ### Installing Runme in Gitpod diff --git a/docs/installation/cli.md b/docs/installation/cli.md index b64d0198..22048652 100644 --- a/docs/installation/cli.md +++ b/docs/installation/cli.md @@ -100,7 +100,7 @@ scoop install stateful/runme ## Installing from Runme Binaries -Alternatively, you can explore Runme's [releases](https://github.com/stateful/runme/releases) and choose the binary that corresponds to your operating system. +Alternatively, you can explore Runme's [releases](https://github.com/runmedev/runme/releases) and choose the binary that corresponds to your operating system. Example: @@ -142,7 +142,7 @@ Additionally, we have provided an option for Go developers to install Runme. If Simply use the command below to carry out this installation: ```sh {"id":"01HQK3RSC9YSH5NM2AE503GRB5"} -go install github.com/stateful/runme@latest +go install github.com/runmedev/runme@latest ``` diff --git a/docs/installation/index.md b/docs/installation/index.md index 42f4bd17..496335af 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -5,7 +5,7 @@ title: Installation # Installation -Install the Runme client for your use-case. The [VS Code extension](/installation/vscode.md) is a great way to start building and running Notebooks (if you don't want to install VS Code, it's easy to [launch a Notebook UI in your browser](/getting-started/web)). The [CLI](/installation/cli) makes it easy to direcly execute commands from your existing Notebooks. Also, if you have Notebooks you want to test in CI/CD, check out the [Github Action](https://github.com/stateful/runme-action). +Install the Runme client for your use-case. The [VS Code extension](/installation/vscode.md) is a great way to start building and running Notebooks (if you don't want to install VS Code, it's easy to [launch a Notebook UI in your browser](/getting-started/web)). The [CLI](/installation/cli) makes it easy to direcly execute commands from your existing Notebooks. Also, if you have Notebooks you want to test in CI/CD, check out the [Github Action](https://github.com/runmedev/runme-action). ## Runme’s Client Interfaces @@ -17,4 +17,4 @@ Runme provides multiple client interfaces that enable you to interact with Runme - [Self-hosted web app version](/getting-started/web) - [CDE's like Codespaces, Gitpod and IDX, Azure AI Studio](/installation/cdes) - [Docker](/installation/docker) -- [Github action](https://github.com/stateful/runme-action) +- [Github action](https://github.com/runmedev/runme-action) diff --git a/docs/resources/limitations.md b/docs/resources/limitations.md index 30bc13a7..60ec13f0 100644 --- a/docs/resources/limitations.md +++ b/docs/resources/limitations.md @@ -1,7 +1,7 @@ # Known Limitations - Runme currently only has rudimentary support for PowerShell. While PowerShell is not limited to Windows, it is its primary platform. We recommend using [WSL](../installation/windows). -- Please [report any issues](https://github.com/stateful/runme/issues/new) you encounter, big or small, to help us make Runme better. +- Please [report any issues](https://github.com/runmedev/runme/issues/new) you encounter, big or small, to help us make Runme better. ## Communication & Support diff --git a/docs/resources/open-source.md b/docs/resources/open-source.md index c5e36580..f150c21b 100644 --- a/docs/resources/open-source.md +++ b/docs/resources/open-source.md @@ -10,11 +10,11 @@ We are committed to building Runme in the open and hope you get involved. Runme' Runme is available in five repositories on Github: -- [Kernel / CLI](https://github.com/stateful/runme) -- [VS Code extension](https://github.com/stateful/vscode-runme) -- [Github action](https://github.com/stateful/runme-action) -- [Docs](https://github.com/stateful/docs.runme.dev) +- [Kernel / CLI](https://github.com/runmedev/runme) +- [VS Code extension](https://github.com/runmedev/vscode-runme) +- [Github action](https://github.com/runmedev/runme-action) +- [Docs](https://github.com/runmedev/docs.runme.dev) ## Need help get started? -For assistance or inquiries, please log any issues on [issues in Github](https://github.com/stateful/runme/issues), or [Join our Community](https://discord.gg/runme). +For assistance or inquiries, please log any issues on [issues in Github](https://github.com/runmedev/runme/issues), or [Join our Community](https://discord.gg/runme). diff --git a/docs/resources/walkthrough.md b/docs/resources/walkthrough.md index 32376523..7a857d77 100644 --- a/docs/resources/walkthrough.md +++ b/docs/resources/walkthrough.md @@ -8,12 +8,12 @@ title: Walkthrough # Runme Walkthrough -> 💡 This document is a self contained Runme Notebook which will guide you through Runme's key features. If you have _VS Code_ installed locally, you can open this document in Runme by clicking the _"Open with Runme"_ badge on __[docs.runme.dev](https://docs.runme.dev/)__ which will open this document as a notebook locally. If you are already inside VS Code, you can skip over the next paragraph. +> 💡 This document is a self contained Runme Notebook which will guide you through Runme's key features. If you have _VS Code_ installed locally, you can open this document in Runme by clicking the _"Open with Runme"_ badge on **[docs.runme.dev](https://docs.runme.dev/)** which will open this document as a notebook locally. If you are already inside VS Code, you can skip over the next paragraph. ## Clone the Repository ```sh {"id":"01HY0Y62WJCT2BVD5VA2HZ32TG"} -git clone --depth=1 https://github.com/stateful/docs.runme.dev.git +git clone --depth=1 https://github.com/runmedev/docs.runme.dev.git cd docs.runme.dev ``` @@ -55,7 +55,7 @@ Create generic documentation and notebooks using Runme's smart prompting feature
-Runme's default prompt setting is _"auto"_, meaning it won't prompt again on re-runs if the values are already known. To change this, click __"Configure"__ on the cell and set `promptEnv` to `never` (never prompt; run as is) or `always` (always prompt; overwrite previous values). +Runme's default prompt setting is _"auto"_, meaning it won't prompt again on re-runs if the values are already known. To change this, click **"Configure"** on the cell and set `promptEnv` to `never` (never prompt; run as is) or `always` (always prompt; overwrite previous values). Try it yourself—just click the play button! @@ -67,7 +67,7 @@ export CLUSTER_ZONE="us-central1-c" echo "CLUSTER_ZONE set to $CLUSTER_ZONE" ``` -You can reset all environment variables using the __Reset Session__ button in the top bar or choose _"Execute and always prompt for input"_ from the caret menu next to the play button. Learn more [here](https://docs.runme.dev/configuration/cell-level#set-environment-variables). +You can reset all environment variables using the **Reset Session** button in the top bar or choose _"Execute and always prompt for input"_ from the caret menu next to the play button. Learn more [here](https://docs.runme.dev/configuration/cell-level#set-environment-variables). ## Piping and Referencing Cells diff --git a/docs/usage/auto-save.md b/docs/usage/auto-save.md index 49ee44b5..90d841ba 100644 --- a/docs/usage/auto-save.md +++ b/docs/usage/auto-save.md @@ -51,7 +51,7 @@ The session outputs are written per Runme session, which is saved throughout the ![reset-session](/img/auto-save-reset-session.png) -If there are more forms you would like to be added to the session output, kindly [let us know](https://github.com/stateful/runme/issues/new). We are open to incorporating your requests. +If there are more forms you would like to be added to the session output, kindly [let us know](https://github.com/runmedev/runme/issues/new). We are open to incorporating your requests. ### Why Separate Session Outputs? diff --git a/docs/usage/browser-launcher-extension.md b/docs/usage/browser-launcher-extension.md index 353e3950..e367e803 100644 --- a/docs/usage/browser-launcher-extension.md +++ b/docs/usage/browser-launcher-extension.md @@ -19,4 +19,4 @@ The web extension adds Runme links to the following places: ![Runme Link in Code Sections](/img/web-extension/code.png) -You can find more information about the development of this web-extension at [`stateful/runme-web-extension`](https://github.com/stateful/runme-web-extension). Feel free to provide feedback and suggestions at any time. +You can find more information about the development of this web-extension at [`stateful/runme-web-extension`](https://github.com/runmedev/runme-web-extension). Feel free to provide feedback and suggestions at any time. diff --git a/docs/usage/runme-gist.md b/docs/usage/runme-gist.md index 4d396f37..f67068e1 100644 --- a/docs/usage/runme-gist.md +++ b/docs/usage/runme-gist.md @@ -101,4 +101,4 @@ Congratulations! You have successfully learned how to use the Runme Gist feature **Note that Session Output files can be kept offline and locally**. -You can read about that [here](https://runme.dev/blog/runme-v3-pipeline-logs-and-artifacts). If you love this feature, kindly give [Runme a star](https://github.com/stateful/runme/stargazers) on GitHub. +You can read about that [here](https://runme.dev/blog/runme-v3-pipeline-logs-and-artifacts). If you love this feature, kindly give [Runme a star](https://github.com/runmedev/runme/stargazers) on GitHub. diff --git a/docs/usage/shebang.md b/docs/usage/shebang.md index e4294f4c..2d8997da 100644 --- a/docs/usage/shebang.md +++ b/docs/usage/shebang.md @@ -248,7 +248,7 @@ Runme auto-detects runtimes based on the language selection per cell. -Missing a language? Please [raise an issue](https://github.com/stateful/runme/issues/new). +Missing a language? Please [raise an issue](https://github.com/runmedev/runme/issues/new). ## Combining Multiple Languages in Your Notebook diff --git a/docusaurus.config.js b/docusaurus.config.js index 6ef71658..4b1c178b 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -96,11 +96,11 @@ const config = { sidebarPath: require.resolve("./sidebars.js"), // Please change this to your repo. // Remove this to remove the "edit this page" links. - editUrl: "https://github.com/stateful/docs.runme.dev/edit/main", + editUrl: "https://github.com/runmedev/docs.runme.dev/edit/main", remarkPlugins: [ [ require("./runme-badge-plugin.js"), - { repository: "https://github.com/stateful/docs.runme.dev.git" }, + { repository: "https://github.com/runmedev/docs.runme.dev.git" }, ], ], }, @@ -108,7 +108,7 @@ const config = { showReadingTime: true, // Please change this to your repo. // Remove this to remove the "edit this page" links. - editUrl: "https://github.com/stateful/docs.runme.dev/edit/main", + editUrl: "https://github.com/runmedev/docs.runme.dev/edit/main", }, theme: { customCss: require.resolve("./src/css/custom.css"), @@ -174,7 +174,7 @@ const config = { className: "discordLink", }, { - href: "https://github.com/stateful/runme", + href: "https://github.com/runmedev/runme", label: "Open Source", position: "right", className: "githubLink", diff --git a/src/components/RunmeStars.tsx b/src/components/RunmeStars.tsx index af38c018..2cfec81b 100644 --- a/src/components/RunmeStars.tsx +++ b/src/components/RunmeStars.tsx @@ -1,7 +1,7 @@ import GitHubButton from "react-github-btn"; const RunmeStars = () => { - const href = "https://github.com/stateful/runme" + const href = "https://github.com/runmedev/runme" const text = "runme" return (
- GitHub + GitHub
Community diff --git a/static/img/integration/runme-dagger-shell-frontmatter.png b/static/img/integration/runme-dagger-shell-frontmatter.png new file mode 100644 index 00000000..ee495874 Binary files /dev/null and b/static/img/integration/runme-dagger-shell-frontmatter.png differ diff --git a/static/img/integration/runme-dagger-shell-named.png b/static/img/integration/runme-dagger-shell-named.png new file mode 100644 index 00000000..4c95478c Binary files /dev/null and b/static/img/integration/runme-dagger-shell-named.png differ diff --git a/static/img/integration/runme-dagger-shell-reference-comment.png b/static/img/integration/runme-dagger-shell-reference-comment.png new file mode 100644 index 00000000..a33e9763 Binary files /dev/null and b/static/img/integration/runme-dagger-shell-reference-comment.png differ diff --git a/static/img/integration/runme-dagger-shell-reference.png b/static/img/integration/runme-dagger-shell-reference.png new file mode 100644 index 00000000..47ec3e2b Binary files /dev/null and b/static/img/integration/runme-dagger-shell-reference.png differ diff --git a/static/img/integration/runme-dagger-shell-snippet.png b/static/img/integration/runme-dagger-shell-snippet.png new file mode 100644 index 00000000..a206d033 Binary files /dev/null and b/static/img/integration/runme-dagger-shell-snippet.png differ diff --git a/static/videos/typed-env-vars.mp4 b/static/videos/typed-env-vars.mp4 new file mode 100644 index 00000000..c50ab8ac Binary files /dev/null and b/static/videos/typed-env-vars.mp4 differ