Skip to content

Commit c78777b

Browse files
committed
Adding content to Sandboxes Docs
1 parent f047481 commit c78777b

File tree

10 files changed

+166
-41
lines changed

10 files changed

+166
-41
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Jetify Cloudboxes",
3+
"position": 1
4+
}
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: FAQ
3+
sidebar_position: 6
4+
hide_title: false
5+
---
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Linking Cloudboxes from your Repo
3+
sidebar_position: 5
4+
hide_title: false
5+
---
6+
7+
You can share Jetify
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Managing Cloudboxes
3+
sidebar_position: 3
4+
hide_title: false
5+
---
6+
Devboxes that you've previously created can be managed from the Jetify Cloudboxes dashboard. From the dashboard, you can start, stop, and delete your previous Cloudboxes.
7+
8+
## Accessing the Cloudboxes Dashboard
9+
10+
To access the Cloudboxes dashboard, navigate to [cloud.jetify.com](https://cloud.jetify.com) and log in with your Jetify account. Once you select an Org, you will can view all the cloudboxes that you have created within that org on the org page.
11+
12+
If you've created any projects in the org, you can also navigate to the project and select the Sandboxes tab to view all the Cloudboxes that you have created for that project.
13+
14+
## Stopping and Starting Cloudboxes
15+
16+
Cloudboxes are automatically stopped after 15 minutes of user inactivity. This is to help you save resources, and avoid being billed for unused Cloudboxes.
17+
18+
If you want to manually stop your Cloudbox, click on the `Options` button on the Cloudbox that you want to stop, and then click on the `Stop` button. Your Cloudboxes package store and project data will be saved, so you can quickly resume your work when you restart the Cloudbox.
19+
20+
:::info
21+
Stopped Cloudboxes are not billed for CPU usage, but you may be billed for storage usage in excess of the free tier.
22+
:::
23+
24+
To restart your Cloudbox, click the option button on the cloud box you want to start, and then click the "Start" button. This will launch the Cloudbox with your previous state and packages.
25+
26+
## Deleting Cloudboxes
27+
28+
By default, Cloudboxes are deleted if they are not used for 14 consecutive days. This is to help you save storage costs, and avoid being billed for unused Cloudbox disks.
29+
30+
If you are done with a Cloudbox, you can delete it by clicking on the `Options` button on the Cloudbox that you want to delete, and then clicking on the `Delete` button. This will permanently delete the Cloudbox and the data associated with it.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Cloudboxes Quickstart
3+
sidebar_position: 1
4+
hide_title: false
5+
---
6+
7+
Jetify Cloudboxes let you spin up reproducible cloud development environments in your browser in seconds. Jetify Cloudboxes are powered by [Devbox](../../index), so you can run your environment on any machine. You can launch any
8+
9+
Let's launch our first Dev Environment with Jetify Cloudboxes.
10+
11+
## Step 1: Launch a Sandbox from Github
12+
13+
You can launch any Github Repo in a Jetify Sandbox by prepend the repo URL with:
14+
15+
```bash
16+
https://cloud.jetify.com/new/
17+
```
18+
19+
For example, to launch the [Devbox repo](https://github.com/jetify-com/devbox) in Jetify Cloudboxes, open the following URL in your browser
20+
21+
[https://cloud.jetify.com/new/github.com/jetify-com/devbox](https://cloud.jetify.com/new/github.com/jetify-com/devbox)
22+
23+
:::tip
24+
If you need some inspiration, you can also launch one of our [template](google.com) projects to get started
25+
:::
26+
27+
You can also launch a new Sandbox by navigating to your [Dashboard](https://cloud.jetify.com/dashboard) and clicking on the `New Sandbox` button.
28+
29+
## Step 2: Customize your Sandbox with Devbox
30+
31+
You can customize your Jetify Sandbox with over 100,000 Nix packages in seconds using Devbox.
32+
33+
If your project doesn't already have a devbox.json, you can initialize one with:
34+
35+
```bash
36+
devbox init
37+
```
38+
39+
Once initialized, you can install your packages using:
40+
41+
```bash
42+
devbox add <package>@<version>
43+
```
44+
45+
For example, to install `python 3.11`, you can run:
46+
47+
```bash
48+
49+
```
50+
51+
You can find packages to install using `devbox search <package>`, or by searching in your browser with [Nixhub](https://www.nixhub.io)
52+
53+
Packages you install will be added to your `devbox.json` file. You can also use this `devbox.json` file configure your environment with [scripts](../../guides/scripts), [services](../../guides/sevices), and more
54+
55+
**Further Reading**
56+
* [Devbox Quickstart](../../quickstart)
57+
* [Devbox CLI Reference](../../cli_reference/devbox)
58+
59+
## Step 3: Save your Dev Environment with `devbox.json`
60+
61+
Once you've customized your environment, you can save your Dev Environment config to source control by checking in your `devbox.json` and `devbox.lock` files. These files can be used to recreate your environment on Jetify Cloudboxes, or on any other machine that has devbox installed.
62+
63+
You can also use this file to configure initilization hooks, scripts, services, and environment variables for your project.
64+
65+
**Further Reading**
66+
* [Devbox Configuration Reference](../../configuration.md)
67+
* [Devbox Script](../../guides/scripts)
68+
* [Devbox Services](../../guide/services)
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Starting a Sandbox
3+
sidebar_position: 2
4+
hide_title: false
5+
---
6+
7+
## Stating a Sandbox from Your Dashboard
8+
9+
## Starting a Sandbox from Github
10+
11+
## Starting a Sandbox from a Template
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Using Cloudboxes with your Team
3+
sidebar_position: 4
4+
hide_title: false
5+
---

docs/app/docs/cloud/sidebar.ts

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,51 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
22

33
const cloudSidebar: SidebarsConfig = {
44
sidebar: [
5+
{
6+
type: "doc",
7+
id: "cloud/index",
8+
},
59
{
610
type: "category",
7-
label: "Managing your Team",
11+
label: "Cloudboxes",
12+
collapsible: false,
813
items: [
914
{
1015
type: "autogenerated",
11-
dirName: "cloud/dashboard",
16+
dirName: "cloud/sandboxes",
1217
},
1318
],
1419
},
1520
{
1621
type: "category",
17-
label: "Caching your Project Packages with Jetify Cache",
22+
label: "Secrets",
23+
collapsible: false,
1824
items: [
1925
{
2026
type: "autogenerated",
21-
dirName: "cloud/cache",
27+
dirName: "cloud/secrets",
2228
},
2329
],
2430
},
2531
{
2632
type: "category",
27-
label: "Syncing and Managing Secrets with Jetify Secrets",
33+
label: "Package Cache",
34+
collapsible: false,
2835
items: [
2936
{
3037
type: "autogenerated",
31-
dirName: "cloud/secrets",
38+
dirName: "cloud/cache",
3239
},
3340
],
3441
},
3542
{
3643
type: "category",
37-
label: "Developing with Jetify Cloudboxes",
44+
label: "Teams and Projects",
45+
collapsible: false,
3846
items: [
3947
{
4048
type: "autogenerated",
41-
dirName: "cloud/sandboxes",
49+
dirName: "cloud/dashboard",
4250
},
4351
],
4452
},

docs/app/docs/nixhub/sidebar.ts

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,23 @@
11
import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
22

33
const nixhubSidebar: SidebarsConfig = {
4-
sidebar:
5-
[
6-
{
7-
type: "doc",
8-
label: "Get a Package",
9-
id: "nixhub/get-a-package",
10-
},
11-
{
12-
type: "doc",
13-
label: "Search Packages",
14-
id: "nixhub/search-packages",
15-
},
16-
{
17-
type: "doc",
18-
label: "Resolve a Package",
19-
id: "nixhub/resolve-a-package-version",
20-
}
21-
]
22-
}
4+
sidebar: [
5+
{
6+
type: "doc",
7+
label: "Get a Package",
8+
id: "nixhub/get-a-package",
9+
},
10+
{
11+
type: "doc",
12+
label: "Search Packages",
13+
id: "nixhub/search-packages",
14+
},
15+
{
16+
type: "doc",
17+
label: "Resolve a Package",
18+
id: "nixhub/resolve-a-package-version",
19+
},
20+
],
21+
};
2322

24-
export default nixhubSidebar.sidebar;
23+
export default nixhubSidebar.sidebar;

docs/app/sidebars.js

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -208,19 +208,7 @@ const sidebars = {
208208
},
209209
],
210210

211-
cloudSidebar: [
212-
{
213-
type: "category",
214-
label: "Jetify Cloud",
215-
collapsed: false,
216-
collapsible: false,
217-
link: {
218-
type: "doc",
219-
id: "cloud/index",
220-
},
221-
items: require("./docs/cloud/sidebar"),
222-
},
223-
],
211+
cloudSidebar: require("./docs/cloud/sidebar"),
224212
};
225213

226214
export default sidebars;

0 commit comments

Comments
 (0)