Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .runme/owl.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
53 changes: 21 additions & 32 deletions dagger/README.md
Original file line number Diff line number Diff line change
@@ -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
```
6 changes: 3 additions & 3 deletions docs/configuration/cell-level.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Your VS Code view will split into two. One side has Notebook view, and the other

<Infobox type="sidenote">

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!

</Infobox>

Expand Down Expand Up @@ -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. |
Expand Down Expand Up @@ -333,7 +333,7 @@ echo "hello world"

<Infobox type="sidenote">

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!

</Infobox>

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/guide/bigquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/guide/cloud-render/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
4 changes: 2 additions & 2 deletions docs/guide/cloud-render/cloud-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/cloud-render/gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Loading