Skip to content

Commit ef22c7b

Browse files
committed
Update Content
1 parent c1eea4d commit ef22c7b

File tree

12 files changed

+131
-105
lines changed

12 files changed

+131
-105
lines changed

docs/app/.envrc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Automatically sets up your devbox environment whenever you cd into this
2+
# directory via our direnv integration:
3+
4+
eval "$(devbox generate direnv --print-envrc)"
5+
6+
# check out https://www.jetpack.io/devbox/docs/ide_configuration/direnv/
7+
# for more details
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"label": "Jetify Cloudboxes",
2+
"label": "Jetify Devspace",
33
"position": 1
44
}

docs/app/cloud/devspace/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ hide_title: false
88

99
Jetify Devspace is a cloud-based development environment that can be customized and preconfigured using Devbox. Your Devspace is fully managed by Jetify, so you don't need to worry about setting up servers or infrastructure to get started.
1010

11-
## What size instances are available for Jetify Sandboxes?
11+
## What size instances are available for Jetify Devspace?
1212

13-
Currently, all Jetify Sandboxes are configured with the following default specs:
13+
Currently, all Jetify Devspace are configured with the following default specs:
1414

1515
* 4 vCPUs
1616
* 16 GB RAM

docs/app/cloud/devspace/index.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,68 @@
1+
---
2+
title: Quickstart
3+
sidebar_position: 1
4+
hide_title: false
5+
---
16

7+
Jetify Devspace let you spin up reproducible cloud development environments in your browser in seconds. Jetify Devspace is powered by [Devbox](/devbox/docs), so you can run your environment on any machine. You can launch any
8+
9+
Let's launch our first Dev Environment in Jetify Devspace.
10+
11+
## Step 1: Launch Jetify Devspace 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), 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 [templates](/devbox/docs/devbox_examples) projects to get started
25+
:::
26+
27+
You can also launch a new Devspace by navigating to your [Dashboard](https://cloud.jetify.com/dashboard) and clicking on the `New Devspace` button.
28+
29+
## Step 2: Customize your Environment with Devbox
30+
31+
You can customize your Jetify Devspace 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](/devbox/docs/guides/scripts), [services](/devbox/docs/guides/services), and more
54+
55+
For further reading on how to install packages with Devbox, see:
56+
57+
* [Devbox Quickstart](/devbox/docs/quickstart)
58+
* [Devbox CLI Reference](/devbox/docs/cli_reference/devbox)
59+
60+
## Step 3: Save your Dev Environment with `devbox.json`
61+
62+
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 Devspace, or on any other machine that has devbox installed.
63+
64+
You can also use this file to configure initialization hooks, scripts, services, and environment variables for your project. For further reading, see:
65+
66+
* [Devbox Configuration Reference](/devbox/docs/configuration)
67+
* [Devbox Script](/devbox/docs/guides/scripts)
68+
* [Devbox Services](/devbox/docs/guides/services)

docs/app/cloud/devspace/link_sandboxes.md

Lines changed: 0 additions & 6 deletions
This file was deleted.
File renamed without changes.

docs/app/cloud/devspace/quickstart.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

docs/app/cloud/devspace/team_sandboxes.md renamed to docs/app/cloud/devspace/sharing_devspaces.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: Sharing Config and Secrets with Projects
2+
title: Sharing Devspace
33
sidebar_position: 4
44
hide_title: false
55
---
66

7-
**Jetify Projects** are a great way to share configuration and secrets with your team. A project can store repository settings and secrets that are shared across all Devspace users in the project. For example, you can configure a project for a Backend API with the database parameters, API keys, and other secrets. When a user launches a Sandbox in the project, they will automatically have access to the project's configuration and secrets.
7+
**Jetify Projects** are a great way to share configuration and secrets with your team. A project can store repository settings and secrets that are shared across all Devspace users in the project. For example, you can configure a project for a Backend API with the database parameters, API keys, and other secrets. When a user launches Jetify Devspace in the project, they will automatically have access to the project's configuration and secrets.
88

99
## Creating a Project
1010

@@ -18,9 +18,9 @@ To create a project:
1818

1919
Once the project is linked to a repository, developers can automatically create a new Sandbox for that repository by navigating to the project and clicking on the `New Sandbox` button.
2020

21-
## Sharing Secrets across Sandboxes
21+
## Sharing Secrets
2222

23-
Jetify Projects can store secrets with Jetify Secrets that are shared across all Devspaces in the project. New Jetify Devspace instance will automatically use the `dev` namespace when accessing secrets.
23+
Jetify Projects can store secrets with Jetify Secrets that are shared across all Devspaces in the project. New Jetify Devspace instances will automatically use the `dev` namespace when accessing secrets.
2424

2525
To add a secret to a project:
2626

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Starting Jetify Devspaces
3+
sidebar_position: 2
4+
hide_title: false
5+
---
6+
7+
## From Your Dashboard
8+
9+
If you have not created a Devspace before, you will need to link your Github Account first in order to grant us permissions to access your repositories.
10+
11+
1. Navigate to the [Jetify Dashboard](https://cloud.jetify.com/dashboard) and clicking on the "**Connect Github Repository**" button.
12+
2. After signing in with Github, you will need to give the Jetify Cloud Github App permissions to access and create repositories on your account.
13+
14+
To create a new Jetify Devspace from your [Jetify Dashboard](https://cloud.jetify.com/):
15+
16+
1. Click "**+ Create New**" button on the top right corner of the page.
17+
2. In the modal that appears, enter the URL of the Github repository you want to use for your Devspace.
18+
3. Click "**Create Devspace**" to start your new Devspace
19+
20+
![Create New Devspace](/img/dashboard_create_new_devspace.png)
21+
22+
Once you've created a Devspace, you can access it from the Devspace list in your Dashboard.
23+
24+
## With a Github URL
25+
26+
You can start Jetify Devspace from any Github Repo by prepending the repo URL with:
27+
28+
```bash
29+
https://cloud.jetify.com/new/
30+
```
31+
32+
For example, you can open the Devbox repo in a Jetify Devspace by opening the following URL in your browser:
33+
34+
```bash
35+
https://cloud.jetify.com/new/github.com/jetify-com/devbox
36+
```
37+
38+
## From a Template
39+
40+
A full list of available templates and projects can be found in the [Devbox Examples](/devbox/docs/devbox_examples/) page of our documentation.
41+
42+
## From a Project
43+
44+
If you've already created a project in the Jetify Dashboard, you can start a new Devspace from the project by navigating to the project and clicking on the "**+ Create New**" button. This will create a new Devspace using the project's configuration and secrets.

docs/app/cloud/devspace/start_a_sandbox.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

0 commit comments

Comments
 (0)