Skip to content

Commit cd34606

Browse files
authored
Add missing READMEs to templates, fix lint (#1418)
## Summary Adds READMEs to each example, so they show up in Templates Content should match what's in the Docs Lints some of the markdown so it passes CI ## How was it tested? Localhost
1 parent 2ffac69 commit cd34606

File tree

30 files changed

+742
-73
lines changed

30 files changed

+742
-73
lines changed

examples/cloud_development/argo-workflows/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,17 @@
22

33
Run and test Argo Workflows on a local Minkube instance.
44

5-
The init_hook in this example configures minikube to store it's data in a local `home/` directory, so your host kubeconfig is not affected by this shell. The scripts in this example do the following:
5+
The init_hook in this example configures minikube to store it's data in a local `home/` directory, so your host kubeconfig is not affected by this shell. The scripts in this example do the following:
66

77
`minikube` starts minikube and tails it's logs
88
`install-argo` Installs Argo Workflows based on the Argo Quickstart documentation
99
`argo-port-forward` Forwards the port of the Argo deployment, so you can access the Argo UI at `https://localhost:2746` (note the `https`).
1010

11-
1211
## Usage Instructions
1312

1413
Note: macOS users need to have Docker Desktop installed. This is because the Docker Daemon cannot run natively on macOS
1514

1615
1. Start `minikube` by running `devbox run minikube`. This will install and spin up minikube in a local shell, and then tail the logs
1716
2. Install argo on minkube using `devbox run argo-install`
1817
3. Forward the ports from your argo deployment using `devbox run argo-port-forward`
19-
4. You can now run `devbox shell`, and use the Argo CLI to interact with Argo in minikube. You can also access the Argo UI at https://localhost:2746
18+
4. You can now run `devbox shell`, and use the Argo CLI to interact with Argo in minikube. You can also access the Argo UI at [https://localhost:2746](https://localhost:2746)

examples/cloud_development/maelstrom/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ You can skip this step if you're running on Devbox.sh
2424

2525
1. You can now follow the docs and run the tests in the Maelstrom Docs + Readme. You can use `glow` from the command line to browse the docs.
2626

27-
This shell includes Ruby 3.10 for running the Ruby Demos. To run demos in other languages, install the appropriate runtimes using `devbox add`. For example, to run the Python demos, use `devbox add python310`.
27+
This shell includes Ruby 3.10 for running the Ruby Demos. To run demos in other languages, install the appropriate runtimes using `devbox add`. For example, to run the Python demos, use `devbox add python310`.

examples/cloud_development/temporal/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ devbox run start-temporal
1919

2020
This will start the temporalite server for testing.
2121

22-
* You can view the WebUI at `localhost:8233`
22+
* You can view the WebUI at `localhost:8233`
2323
* By default, Temporal will listen for activities/requests on port `7233`
2424

2525
## Starting a Devbox Shell
@@ -28,7 +28,7 @@ This will start the temporalite server for testing.
2828
devbox shell
2929
```
3030

31-
This will activate a virtual environment and install the Temporal Python SDK.
31+
This will activate a virtual environment and install the Temporal Python SDK.
3232

3333
## Testing the Temporal Workflows
3434

examples/databases/mysql/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ Use `devbox services start|stop [service]` to interact with services
1414

1515
## This plugin sets the following environment variables
1616

17-
* MYSQL_BASEDIR=/<projectDir>/.devbox/nix/profile/default
18-
* MYSQL_HOME=/<projectDir>/.devbox/virtenv/mysql/run
19-
* MYSQL_DATADIR=/<projectDir>/.devbox/virtenv/mysql/data
20-
* MYSQL_UNIX_PORT=/<projectDir>/.devbox/virtenv/mysql/run/mysql.sock
21-
* MYSQL_PID_FILE=/<projectDir>/.devbox/virtenv/mysql/run/mysql.pid
17+
* MYSQL_BASEDIR=&lt;projectDir>/.devbox/nix/profile/default
18+
* MYSQL_HOME=&lt;projectDir>/.devbox/virtenv/mysql/run
19+
* MYSQL_DATADIR=&lt;projectDir>/.devbox/virtenv/mysql/data
20+
* MYSQL_UNIX_PORT=&lt;projectDir>/.devbox/virtenv/mysql/run/mysql.sock
21+
* MYSQL_PID_FILE=&lt;projectDir>/.devbox/virtenv/mysql/run/mysql.pid
2222

2323
To show this information, run `devbox info mysql`
2424

2525
Note that the `.sock` filepath can only be maximum 100 characters long. You can point to a different path by setting the `MYSQL_UNIX_PORT` env variable in your `devbox.json` as follows:
2626

27-
```
27+
```json
2828
"env": {
2929
"MYSQL_UNIX_PORT": "/<some-other-path>/mysql.sock"
3030
}
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: C# and .NET
3+
---
4+
5+
C# and .NET projects can be easily generated in Devbox by adding the dotnet SDK to your project. You can then create new projects using `dotnet new`
6+
7+
[**Example Repo**](https://github.com/jetpack-io/devbox/tree/main/examples/development/csharp)
8+
9+
[![Open In Devbox.sh](https://jetpack.io/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/dotnet)
10+
11+
## Adding .NET to your project
12+
13+
`devbox add dotnet-sdk`, or add the following to your `devbox.json`:
14+
15+
```json
16+
"packages": [
17+
"dotnet-sdk@latest"
18+
],
19+
```
20+
21+
This will install the latest version of the dotnet SDK. You can find other installable versions of the dotnet SDK by running `devbox search dotnet-sdk`.
22+
23+
If you need a specific version of the .NET SDK, you can search on [Nixhub](https://www.nixhub.io/search?q=dotnet)
24+
25+
## Creating a new C# Project
26+
27+
`dotnet new console -lang "C#" -o <name>`

examples/development/elixir/README.md

Whitespace-only changes.

examples/development/elixir/elixir_hello/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Elixir
22

3-
Basic Elixir project using Mix in Devbox.
3+
Basic Elixir project using Mix in Devbox.
44

55
## Configuration
66

@@ -28,4 +28,3 @@ end
2828
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
2929
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
3030
be found at <https://hexdocs.pm/elixir_hello>.
31-
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: F# and .NET
3+
---
4+
5+
F# and .NET projects can be easily generated in Devbox by adding the dotnet SDK to your project. You can then create new projects using `dotnet new`
6+
7+
[**Example Repo**](https://github.com/jetpack-io/devbox/tree/main/examples/development/fsharp)
8+
9+
[![Open In Devbox.sh](https://jetpack.io/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/fsharp)
10+
11+
## Adding .NET to your project
12+
13+
`devbox add dotnet-sdk`, or add the following to your `devbox.json`:
14+
15+
```json
16+
"packages": [
17+
"dotnet-sdk@latest"
18+
],
19+
```
20+
21+
This will install the latest version of the dotnet SDK. You can find other installable versions of the dotnet SDK by running `devbox search dotnet-sdk`. You can also view the available versions on [Nixhub](https://www.nixhub.io/search?q=dotnet)
22+
23+
## Creating a new F# Project
24+
25+
`dotnet new console -lang "F#" -o <name>`
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Go
3+
---
4+
5+
Go projects can be run in Devbox by adding the Go SDK to your project. If your project uses cgo or compiles against C libraries, you should also include them in your packages to ensure Go can compile successfully
6+
7+
[**Example Repo**](https://github.com/jetpack-io/devbox/tree/main/examples/development/go/hello-world)
8+
9+
[![Open In Devbox.sh](https://jetpack.io/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/go)
10+
11+
## Adding Go to your Project
12+
13+
`devbox add go`, or add the following to your `devbox.json`
14+
15+
```json
16+
"packages": [
17+
"go@latest"
18+
]
19+
```
20+
21+
This will install the latest version of the Go SDK. You can find other installable versions of Go by running `devbox search go`. You can also view the available versions on [Nixhub](https://www.nixhub.io/packages/go)
22+
23+
If you need additional C libraries, you can add them along with `gcc` to your package list. For example, if libcap is required for yoru project:
24+
25+
```json
26+
"packages": [
27+
"go",
28+
"gcc",
29+
"libcap"
30+
]
31+
```
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Haskell
3+
---
4+
5+
Haskell projects that use the Stack Framework can be run in Devbox by adding the Stack and the Cabal packages to your project. You may also want to include libraries that Stack requires for compilation (described below)
6+
7+
[**Example Repo**](https://github.com/jetpack-io/devbox/tree/main/examples/development/haskell/)
8+
9+
## Adding Haskell and Stack to your Project
10+
11+
`devbox add stack cabal-install zlib hpack`, or add the following to your `devbox.json`
12+
13+
```json
14+
"packages": [
15+
"stack@latest",
16+
"cabal-install@latest",
17+
"zlib@latest",
18+
"hpack@latest"
19+
]
20+
```
21+
22+
This will install GHC, and the Haskell Tool Stack in your Devbox Shell at their latest version. You can find other installable versions of Stack by running `devbox search <pkg>`.

0 commit comments

Comments
 (0)