Skip to content

Commit d4cf421

Browse files
authored
Reorganize docs (#2323)
## Summary Reorganize into: `/docs/devbox` `/docs/cloud` `/docs/nixhub` ## How was it tested? Localhost, pnpm build, vercel
1 parent 3ed10ab commit d4cf421

32 files changed

+13930
-32538
lines changed

docs/app/cloud/devspace/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 1
44
hide_title: false
55
---
66

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
7+
Jetify Devspace let you spin up reproducible cloud development environments in your browser in seconds. Jetify Devspace is powered by [Devbox](/devbox), so you can run your environment on any machine. You can launch any
88

99
Let's launch our first Dev Environment in Jetify Devspace.
1010

@@ -21,7 +21,7 @@ For example, to launch the [Devbox repo](https://github.com/jetify-com/devbox),
2121
[https://cloud.jetify.com/new/github.com/jetify-com/devbox](https://cloud.jetify.com/new/github.com/jetify-com/devbox)
2222

2323
:::tip
24-
If you need some inspiration, you can also launch one of our [templates](/devbox/docs/devbox_examples) projects to get started
24+
If you need some inspiration, you can also launch one of our [templates](/docs/devbox/devbox_examples) projects to get started
2525
:::
2626

2727
You can also launch a new Devspace by navigating to your [Dashboard](https://cloud.jetify.com/dashboard) and clicking on the `New Devspace` button.
@@ -50,19 +50,19 @@ devbox add [email protected]
5050

5151
You can find packages to install using `devbox search <package>`, or by searching in your browser with [Nixhub](https://www.nixhub.io)
5252

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
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](/docs/devbox/guides/scripts), [services](/docs/devbox/guides/services), and more
5454

5555
For further reading on how to install packages with Devbox, see:
5656

57-
* [Devbox Quickstart](/devbox/docs/quickstart)
58-
* [Devbox CLI Reference](/devbox/docs/cli_reference/devbox)
57+
* [Devbox Quickstart](/docs/devbox/quickstart)
58+
* [Devbox CLI Reference](/docs/devbox/cli_reference/devbox)
5959

6060
## Step 3: Save your Dev Environment with `devbox.json`
6161

6262
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.
6363

6464
You can also use this file to configure initialization hooks, scripts, services, and environment variables for your project. For further reading, see:
6565

66-
* [Devbox Configuration Reference](/devbox/docs/configuration)
67-
* [Devbox Script](/devbox/docs/guides/scripts)
68-
* [Devbox Services](/devbox/docs/guides/services)
66+
* [Devbox Configuration Reference](/docs/devbox/configuration)
67+
* [Devbox Script](/docs/devbox/guides/scripts)
68+
* [Devbox Services](/docs/devbox/guides/services)

docs/app/cloud/devspace/start_a_devspace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ https://cloud.jetify.com/new/github.com/jetify-com/devbox
3737

3838
## From a Template
3939

40-
A full list of available templates and projects can be found in the [Devbox Examples](/devbox/docs/devbox_examples/) page of our documentation.
40+
A full list of available templates and projects can be found in the [Devbox Examples](/docs/devbox/devbox_examples/) page of our documentation.
4141

4242
## From a Project
4343

docs/app/cloud/secrets/secrets_cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 3
55

66
You can access your Jetify Secrets locally using Devbox. When you authenticate your Devbox CLI with Jetify Cloud, Devbox will automatically identify your project, and make your secrets available in your Devbox shell. Developers who are part of your Jetify Cloud team can also access your project’s secrets automatically, whenever they use devbox to start a shell, run a script, or launch a service
77

8-
If you don't already have Devbox installed, see our [Quickstart](https://www.jetify.com/devbox/docs/quickstart/) guide to get started.
8+
If you don't already have Devbox installed, see our [Quickstart](https://www.jetify.com/docs/devbox/quickstart/) guide to get started.
99

1010
## Authenticating with Devbox
1111

@@ -134,5 +134,5 @@ You can download from a specific environment using the `--environment` flag:
134134
135135
## Further Reading
136136
137-
- [Devbox Secrets CLI Reference](/devbox/docs/cli_reference/devbox_secrets)
137+
- [Devbox Secrets CLI Reference](/docs/devbox/cli_reference/devbox_secrets)
138138
- [Managing Secrets from the Dashboard](../dashboard_secrets)

docs/app/docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ You can securely load secrets from Jetify Secrets by running `devbox secrets ini
206206
}
207207
```
208208

209-
Note that setting secrets securetly with Jetify Secrets requires a Jetify Cloud account. For more information, see the [Jetify Secrets](/cloud/docs/secrets/) guide.
209+
Note that setting secrets securetly with Jetify Secrets requires a Jetify Cloud account. For more information, see the [Jetify Secrets](/docs/cloud/secrets/) guide.
210210

211211
### Shell
212212

docs/app/docs/contributor-quickstart.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@ Devbox requires the [Nix Package Manager](https://nixos.org/download.html). If N
8080
8181
### Boost your dev environment with Jetify Cloud
8282
83-
* **[Jetify Secrets](/cloud/docs/secrets/):** Securely store and access your secrets and environment variables in your Devbox projects.
84-
* **[Jetify Deploys](/cloud/docs/deploys/):** Deploy your Devbox projects as autoscaling services with a single command.
85-
* **[Jetify Cache](/cloud/docs/cache/):** Share and cache packages across all your Devbox projects and environments.
86-
* **[Jetify Prebuilt Cache](/cloud/docs/cache/):** Use the Jetify Public Cache to speed up your Devbox builds and share packages with the community.
83+
* **[Jetify Secrets](/docs/cloud/secrets/):** Securely store and access your secrets and environment variables in your Devbox projects.
84+
* **[Jetify Deploys](/docs/cloud/deploys/):** Deploy your Devbox projects as autoscaling services with a single command.
85+
* **[Jetify Cache](/docs/cloud/cache/):** Share and cache packages across all your Devbox projects and environments.
86+
* **[Jetify Prebuilt Cache](/docs/cloud/cache/):** Use the Jetify Public Cache to speed up your Devbox builds and share packages with the community.
8787
8888
### Get Involved
8989
* **[Join our Discord Community](https://discord.gg/jetify):** Chat with the development team and our growing community of Devbox users.

docs/app/docs/devbox_examples/stacks/django.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This example demonstrates how to configure and run a Django app using Devbox. It
88

99
## How to Use
1010

11-
1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/)
11+
1. Install [Devbox](https://www.jetify.com/docs/devbox/installing_devbox/)
1212
1. Run `devbox shell` to install your packages and run the init_hook. This will activate your virtual environment and install Django.
1313
1. Initialize PostgreSQL with `devbox run initdb`.
1414
1. In the root directory, run `devbox run create_db` to create the database and run your Django migrations.
@@ -18,7 +18,7 @@ This example demonstrates how to configure and run a Django app using Devbox. It
1818

1919
### Setting up the Project
2020

21-
1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/).
21+
1. Install [Devbox](https://www.jetify.com/docs/devbox/installing_devbox/).
2222
1. Run `devbox init` to create a new Devbox project in your directory.
2323
1. Install Python and PostgreSQL with `devbox install python python310Packages.pip openssl postgresql`. This will also install the Devbox plugins for pip (which sets up your .venv directory) and PostgreSQL.
2424
1. Copy the requirements.txt and `todo_project` directory into the root folder of your project

docs/app/docs/devbox_examples/stacks/jekyll.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ Inspired by [](https://litchipi.github.io/nix/2023/01/12/build-jekyll-blog-with-
1212

1313
## How to Run
1414

15-
1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/)
15+
1. Install [Devbox](https://www.jetify.com/docs/devbox/installing_devbox/)
1616
2. Run `devbox shell` to install your packages and run the init hook
1717
3. In the root directory, run `devbox run generate` to install and package the project with bundler
1818
4. In the root directory, run `devbox run server` to start the server. You can access the Jekyll example at `localhost:4000`
1919

2020
## How to Recreate this Example
2121

22-
1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/)
22+
1. Install [Devbox](https://www.jetify.com/docs/devbox/installing_devbox/)
2323
1. In a new directory, run `devbox init` to create an empty config
2424
1. Run `devbox add ruby_3_1 bundler` to add Ruby and Bundler to your packages
2525
1. Add `"gem install jekyll --version \"~> 3.9.2\""` to your init hook. This will install the Jekyll gem in your local project.

docs/app/docs/devbox_examples/stacks/laravel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This example shows how to build a simple Laravel application backed by MariaDB a
1212

1313
## How to Run
1414

15-
1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/)
15+
1. Install [Devbox](https://www.jetify.com/docs/devbox/installing_devbox/)
1616

1717
1. Create a new Laravel App by running `devbox create --template laravel`. This will create a new Laravel project in your current directory.
1818

docs/app/docs/devbox_examples/stacks/spring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This example combines Java, Spring Boot, and MySQL to expose a simple REST API.
99

1010
## How to Run
1111

12-
1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/)
12+
1. Install [Devbox](https://www.jetify.com/docs/devbox/installing_devbox/)
1313

1414
1. Prepare the database by running `devbox run setup_db`. This will create the user and database that Spring expects in `stacks/spring/src/main/resources/application.properties`
1515
1. You can now start the Spring Boot service by running `devbox run bootRun`. This will start your MySQL service and run the application

docs/app/docs/env_variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Devbox Env Variables
44

55
The following is a list of Environment variables used by Devbox to manage your environment. Some of these variables are set by Devbox, while others can be used to manage how Devbox sets up your shell.
66

7-
Note that this list only describes variables that are set by Devbox itself. [Devbox plugins](/devbox/docs/guides/plugins) may set their own environment variables, which are documented in their respective pages and via `devbox info <package>`.
7+
Note that this list only describes variables that are set by Devbox itself. [Devbox plugins](/docs/devbox/guides/plugins) may set their own environment variables, which are documented in their respective pages and via `devbox info <package>`.
88

99
## Environment Variables Set by Devbox Shell
1010

0 commit comments

Comments
 (0)