From ce3f10d5e7068f1de1cfdb6ce7a773f6aba9e776 Mon Sep 17 00:00:00 2001 From: John Lago <750845+Lagoja@users.noreply.github.com> Date: Fri, 4 Oct 2024 14:40:34 -0700 Subject: [PATCH] broken links --- docs/app/cloud/devspace/index.md | 16 ++++++++-------- docs/app/cloud/devspace/start_a_devspace.md | 2 +- docs/app/cloud/secrets/secrets_cli.md | 4 ++-- docs/app/docs/configuration.md | 2 +- docs/app/docs/contributor-quickstart.md | 8 ++++---- docs/app/docs/devbox_examples/stacks/django.md | 4 ++-- docs/app/docs/devbox_examples/stacks/jekyll.md | 4 ++-- docs/app/docs/devbox_examples/stacks/laravel.md | 2 +- docs/app/docs/devbox_examples/stacks/spring.md | 2 +- docs/app/docs/env_variables.md | 2 +- docs/app/docs/faq.md | 4 ++-- docs/app/docs/guides/creating_plugins.md | 2 +- docs/app/docs/guides/secrets.md | 6 +++--- docs/app/docs/guides/using_flakes.md | 2 +- docs/app/docs/ide_configuration/direnv.md | 8 ++++---- docs/app/docs/ide_configuration/vscode.md | 2 +- docs/app/docs/quickstart.mdx | 8 ++++---- 17 files changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/app/cloud/devspace/index.md b/docs/app/cloud/devspace/index.md index 70a0fad06da..f41a51498c1 100644 --- a/docs/app/cloud/devspace/index.md +++ b/docs/app/cloud/devspace/index.md @@ -4,7 +4,7 @@ sidebar_position: 1 hide_title: false --- -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 +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 Let's launch our first Dev Environment in Jetify Devspace. @@ -21,7 +21,7 @@ For example, to launch the [Devbox repo](https://github.com/jetify-com/devbox), [https://cloud.jetify.com/new/github.com/jetify-com/devbox](https://cloud.jetify.com/new/github.com/jetify-com/devbox) :::tip - If you need some inspiration, you can also launch one of our [templates](/devbox/docs/devbox_examples) projects to get started + If you need some inspiration, you can also launch one of our [templates](/docs/devbox/devbox_examples) projects to get started ::: 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,12 +50,12 @@ devbox add python@3.11 You can find packages to install using `devbox search `, or by searching in your browser with [Nixhub](https://www.nixhub.io) -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 +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 For further reading on how to install packages with Devbox, see: -* [Devbox Quickstart](/devbox/docs/quickstart) -* [Devbox CLI Reference](/devbox/docs/cli_reference/devbox) +* [Devbox Quickstart](/docs/devbox/quickstart) +* [Devbox CLI Reference](/docs/devbox/cli_reference/devbox) ## Step 3: Save your Dev Environment with `devbox.json` @@ -63,6 +63,6 @@ Once you've customized your environment, you can save your Dev Environment confi You can also use this file to configure initialization hooks, scripts, services, and environment variables for your project. For further reading, see: -* [Devbox Configuration Reference](/devbox/docs/configuration) -* [Devbox Script](/devbox/docs/guides/scripts) -* [Devbox Services](/devbox/docs/guides/services) +* [Devbox Configuration Reference](/docs/devbox/configuration) +* [Devbox Script](/docs/devbox/guides/scripts) +* [Devbox Services](/docs/devbox/guides/services) diff --git a/docs/app/cloud/devspace/start_a_devspace.md b/docs/app/cloud/devspace/start_a_devspace.md index eb82f7191ca..48bb1fc29d6 100644 --- a/docs/app/cloud/devspace/start_a_devspace.md +++ b/docs/app/cloud/devspace/start_a_devspace.md @@ -37,7 +37,7 @@ https://cloud.jetify.com/new/github.com/jetify-com/devbox ## From a Template -A full list of available templates and projects can be found in the [Devbox Examples](/devbox/docs/devbox_examples/) page of our documentation. +A full list of available templates and projects can be found in the [Devbox Examples](/docs/devbox/devbox_examples/) page of our documentation. ## From a Project diff --git a/docs/app/cloud/secrets/secrets_cli.md b/docs/app/cloud/secrets/secrets_cli.md index 3e5e10318f3..04e62a110da 100644 --- a/docs/app/cloud/secrets/secrets_cli.md +++ b/docs/app/cloud/secrets/secrets_cli.md @@ -5,7 +5,7 @@ sidebar_position: 3 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 -If you don't already have Devbox installed, see our [Quickstart](https://www.jetify.com/devbox/docs/quickstart/) guide to get started. +If you don't already have Devbox installed, see our [Quickstart](https://www.jetify.com/docs/devbox/quickstart/) guide to get started. ## Authenticating with Devbox @@ -134,5 +134,5 @@ You can download from a specific environment using the `--environment` flag: ## Further Reading -- [Devbox Secrets CLI Reference](/devbox/docs/cli_reference/devbox_secrets) +- [Devbox Secrets CLI Reference](/docs/devbox/cli_reference/devbox_secrets) - [Managing Secrets from the Dashboard](../dashboard_secrets) diff --git a/docs/app/docs/configuration.md b/docs/app/docs/configuration.md index 6036f03db25..dcad736775a 100644 --- a/docs/app/docs/configuration.md +++ b/docs/app/docs/configuration.md @@ -206,7 +206,7 @@ You can securely load secrets from Jetify Secrets by running `devbox secrets ini } ``` -Note that setting secrets securetly with Jetify Secrets requires a Jetify Cloud account. For more information, see the [Jetify Secrets](/cloud/docs/secrets/) guide. +Note that setting secrets securetly with Jetify Secrets requires a Jetify Cloud account. For more information, see the [Jetify Secrets](/docs/cloud/secrets/) guide. ### Shell diff --git a/docs/app/docs/contributor-quickstart.md b/docs/app/docs/contributor-quickstart.md index 31090c457ae..7dc5e50ac7f 100644 --- a/docs/app/docs/contributor-quickstart.md +++ b/docs/app/docs/contributor-quickstart.md @@ -80,10 +80,10 @@ Devbox requires the [Nix Package Manager](https://nixos.org/download.html). If N ### Boost your dev environment with Jetify Cloud -* **[Jetify Secrets](/cloud/docs/secrets/):** Securely store and access your secrets and environment variables in your Devbox projects. -* **[Jetify Deploys](/cloud/docs/deploys/):** Deploy your Devbox projects as autoscaling services with a single command. -* **[Jetify Cache](/cloud/docs/cache/):** Share and cache packages across all your Devbox projects and environments. -* **[Jetify Prebuilt Cache](/cloud/docs/cache/):** Use the Jetify Public Cache to speed up your Devbox builds and share packages with the community. +* **[Jetify Secrets](/docs/cloud/secrets/):** Securely store and access your secrets and environment variables in your Devbox projects. +* **[Jetify Deploys](/docs/cloud/deploys/):** Deploy your Devbox projects as autoscaling services with a single command. +* **[Jetify Cache](/docs/cloud/cache/):** Share and cache packages across all your Devbox projects and environments. +* **[Jetify Prebuilt Cache](/docs/cloud/cache/):** Use the Jetify Public Cache to speed up your Devbox builds and share packages with the community. ### Get Involved * **[Join our Discord Community](https://discord.gg/jetify):** Chat with the development team and our growing community of Devbox users. diff --git a/docs/app/docs/devbox_examples/stacks/django.md b/docs/app/docs/devbox_examples/stacks/django.md index ad239f4853e..af2bdcabf5b 100644 --- a/docs/app/docs/devbox_examples/stacks/django.md +++ b/docs/app/docs/devbox_examples/stacks/django.md @@ -8,7 +8,7 @@ This example demonstrates how to configure and run a Django app using Devbox. It ## How to Use -1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/) +1. Install [Devbox](https://www.jetify.com/docs/devbox/installing_devbox/) 1. Run `devbox shell` to install your packages and run the init_hook. This will activate your virtual environment and install Django. 1. Initialize PostgreSQL with `devbox run initdb`. 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 ### Setting up the Project -1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/). +1. Install [Devbox](https://www.jetify.com/docs/devbox/installing_devbox/). 1. Run `devbox init` to create a new Devbox project in your directory. 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. 1. Copy the requirements.txt and `todo_project` directory into the root folder of your project diff --git a/docs/app/docs/devbox_examples/stacks/jekyll.md b/docs/app/docs/devbox_examples/stacks/jekyll.md index 43c8204a68d..edff2a7a794 100644 --- a/docs/app/docs/devbox_examples/stacks/jekyll.md +++ b/docs/app/docs/devbox_examples/stacks/jekyll.md @@ -12,14 +12,14 @@ Inspired by [](https://litchipi.github.io/nix/2023/01/12/build-jekyll-blog-with- ## How to Run -1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/) +1. Install [Devbox](https://www.jetify.com/docs/devbox/installing_devbox/) 2. Run `devbox shell` to install your packages and run the init hook 3. In the root directory, run `devbox run generate` to install and package the project with bundler 4. In the root directory, run `devbox run server` to start the server. You can access the Jekyll example at `localhost:4000` ## How to Recreate this Example -1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/) +1. Install [Devbox](https://www.jetify.com/docs/devbox/installing_devbox/) 1. In a new directory, run `devbox init` to create an empty config 1. Run `devbox add ruby_3_1 bundler` to add Ruby and Bundler to your packages 1. Add `"gem install jekyll --version \"~> 3.9.2\""` to your init hook. This will install the Jekyll gem in your local project. diff --git a/docs/app/docs/devbox_examples/stacks/laravel.md b/docs/app/docs/devbox_examples/stacks/laravel.md index 0c61eacd283..a47994b7dc3 100644 --- a/docs/app/docs/devbox_examples/stacks/laravel.md +++ b/docs/app/docs/devbox_examples/stacks/laravel.md @@ -12,7 +12,7 @@ This example shows how to build a simple Laravel application backed by MariaDB a ## How to Run -1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/) +1. Install [Devbox](https://www.jetify.com/docs/devbox/installing_devbox/) 1. Create a new Laravel App by running `devbox create --template laravel`. This will create a new Laravel project in your current directory. diff --git a/docs/app/docs/devbox_examples/stacks/spring.md b/docs/app/docs/devbox_examples/stacks/spring.md index 5fc77b0ef67..0dd5a713554 100644 --- a/docs/app/docs/devbox_examples/stacks/spring.md +++ b/docs/app/docs/devbox_examples/stacks/spring.md @@ -9,7 +9,7 @@ This example combines Java, Spring Boot, and MySQL to expose a simple REST API. ## How to Run -1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/) +1. Install [Devbox](https://www.jetify.com/docs/devbox/installing_devbox/) 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` 1. You can now start the Spring Boot service by running `devbox run bootRun`. This will start your MySQL service and run the application diff --git a/docs/app/docs/env_variables.md b/docs/app/docs/env_variables.md index 8119ac6075d..0bde8d72fd7 100644 --- a/docs/app/docs/env_variables.md +++ b/docs/app/docs/env_variables.md @@ -4,7 +4,7 @@ title: Devbox Env Variables 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. -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 `. +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 `. ## Environment Variables Set by Devbox Shell diff --git a/docs/app/docs/faq.md b/docs/app/docs/faq.md index dd9dfb919f2..a6bdee46850 100644 --- a/docs/app/docs/faq.md +++ b/docs/app/docs/faq.md @@ -49,7 +49,7 @@ devbox add github:NixOS/nixpkgs#prometheus^out,cli Packages may take a long time to install if they do not have a binary available in the public Nix Cache. If a prebuilt binary is not available, Nix will built the package from source. -If prebuilt binaries are not available in the public cache, you may want to use the [Jetify Cache](/cloud/docs/cache/) or the [Jetify Prebuilt Cache](/cloud/docs/cache/prebuilt_cache) to cache the binaries you build for future use. Using a package cache can reduce package install by up to 90% compared to building from source. +If prebuilt binaries are not available in the public cache, you may want to use the [Jetify Cache](/docs/cloud/cache/) or the [Jetify Prebuilt Cache](/docs/cloud/cache/prebuilt_cache) to cache the binaries you build for future use. Using a package cache can reduce package install by up to 90% compared to building from source. ## I'm trying to build a project, but it says that I'm missing `libstdc++`. How do I install this library in my project? @@ -66,7 +66,7 @@ There are three ways to work around this issue: ## How can I use custom Nix packages or overrides with Devbox? -You can add customized packages to your Devbox environment using our [Flake support](/devbox/docs/guides/using_flakes). You can use these flakes to modify or override packages from nixpkgs, or to create your own custom packages. +You can add customized packages to your Devbox environment using our [Flake support](/docs/devbox/guides/using_flakes). You can use these flakes to modify or override packages from nixpkgs, or to create your own custom packages. ## Can I use Devbox if I use [Fish](https://fishshell.com/)? diff --git a/docs/app/docs/guides/creating_plugins.md b/docs/app/docs/guides/creating_plugins.md index 7e4962b9b1a..d5000853fea 100644 --- a/docs/app/docs/guides/creating_plugins.md +++ b/docs/app/docs/guides/creating_plugins.md @@ -6,7 +6,7 @@ Plugins make it easier to get started with packages that require additional setu ## Getting Started -Before writing a plugin, we recommend reading the [User Documentation](https://www.jetify.com/devbox/docs/guides/plugins/) on plugins, as well as inspecting and testing a few of the plugins in the [plugin directory](https://github.com/jetify-com/devbox/tree/main/plugins) of our repo. Note that the plugins in this directory are compiled into the Devbox binary, but your plugin can be sourced from a local directory or from within your project. +Before writing a plugin, we recommend reading the [User Documentation](https://www.jetify.com/docs/devbox/guides/plugins/) on plugins, as well as inspecting and testing a few of the plugins in the [plugin directory](https://github.com/jetify-com/devbox/tree/main/plugins) of our repo. Note that the plugins in this directory are compiled into the Devbox binary, but your plugin can be sourced from a local directory or from within your project. If you're looking for plugin ideas, check out our [Issues page](https://github.com/jetify-com/devbox/issues?q=is%3Aissue+is%3Aopen+label%3A%22plugin+request%22) for any user requests. diff --git a/docs/app/docs/guides/secrets.md b/docs/app/docs/guides/secrets.md index 8e2b3b187cc..10035232a0f 100644 --- a/docs/app/docs/guides/secrets.md +++ b/docs/app/docs/guides/secrets.md @@ -18,7 +18,7 @@ Environment variables that do not need to be stored securely can be set directly } ``` -Currently, you can only set values using string literals, `$PWD`, and `$PATH`. Any other values with environment variables will not be expanded when starting your shell. For more details, see (/devbox/docs/configuration.md). +Currently, you can only set values using string literals, `$PWD`, and `$PATH`. Any other values with environment variables will not be expanded when starting your shell. For more details, see (/docs/devbox/configuration.md). ## Setting Environment Variables with Env Files @@ -36,8 +36,8 @@ For environment variables that you want to keep out of your `devbox.json` file, ## Securely Managing Secrets with Jetify Secrets -For secrets that need to be stored securely, you can use Jetify Secrets. Jetify Secrets is a secure secrets management service that allows you to store and manage your secrets with Jetify. You can then access your secrets whenever you start your Devbox shell, and manage them from the CLI using [`devbox secrets`](/devbox/docs/cli_reference/devbox_secrets). +For secrets that need to be stored securely, you can use Jetify Secrets. Jetify Secrets is a secure secrets management service that allows you to store and manage your secrets with Jetify. You can then access your secrets whenever you start your Devbox shell, and manage them from the CLI using [`devbox secrets`](/docs/devbox/cli_reference/devbox_secrets). To get started with Jetify Secrets, you will need to first create an account on Jetify Cloud and login with `devbox auth login`. Once your account is created, you can create a new project and start adding secrets to your project using `devbox secrets init`. -For more details on how to manage your secrets from the CLI, see our guide on [**Jetify Secrets**](/cloud/docs/secrets/secrets_cli). +For more details on how to manage your secrets from the CLI, see our guide on [**Jetify Secrets**](/docs/cloud/secrets/secrets_cli). diff --git a/docs/app/docs/guides/using_flakes.md b/docs/app/docs/guides/using_flakes.md index 3637770146d..c6ec5e74d53 100644 --- a/docs/app/docs/guides/using_flakes.md +++ b/docs/app/docs/guides/using_flakes.md @@ -93,7 +93,7 @@ path:./my-flake#my-package ## Caching Flakes with the Jetify Cache -Because flakes are not automatically built and cached by Nix, you may experience slower build times when using flakes in your Devbox project. To speed up your builds, you can use the [Jetify Cache](/cloud/docs/cache/) to cache the binaries built by your flakes for future use. +Because flakes are not automatically built and cached by Nix, you may experience slower build times when using flakes in your Devbox project. To speed up your builds, you can use the [Jetify Cache](/docs/cloud/cache/) to cache the binaries built by your flakes for future use. After setting up your cache directly, you can upload the flake by running: diff --git a/docs/app/docs/ide_configuration/direnv.md b/docs/app/docs/ide_configuration/direnv.md index e636915d9c9..9f481b6a4e9 100644 --- a/docs/app/docs/ide_configuration/direnv.md +++ b/docs/app/docs/ide_configuration/direnv.md @@ -20,7 +20,7 @@ If you have direnv installed, Devbox will generate an .envrc file when you run ` ➜ devbox generate direnv Success: generated .envrc file Success: ran `direnv allow` -direnv: loading ~/src/devbox/docs/.envrc +direnv: loading ~/src/docs/devbox/.envrc direnv: using devbox ``` @@ -35,7 +35,7 @@ For an existing project, you can add a `.envrc` file by running `devbox generate ➜ devbox generate direnv Success: generated .envrc file Success: ran `direnv allow` -direnv: loading ~/src/devbox/docs/.envrc +direnv: loading ~/src/docs/devbox/.envrc direnv: using devbox ``` @@ -59,7 +59,7 @@ The resulting .envrc will have the following: eval "$(devbox generate direnv --print-envrc --env MY_CUSTOM_ENV_VAR=my-value)" -# check out https://www.jetify.com/devbox/docs/ide_configuration/direnv/ +# check out https://www.jetify.com/docs/devbox/ide_configuration/direnv/ # for more details ``` @@ -77,7 +77,7 @@ The resulting .envrc will have the following: eval "$(devbox generate direnv --print-envrc --env-file .env.devbox)" -# check out https://www.jetify.com/devbox/docs/ide_configuration/direnv/ +# check out https://www.jetify.com/docs/devbox/ide_configuration/direnv/ # for more details ``` diff --git a/docs/app/docs/ide_configuration/vscode.md b/docs/app/docs/ide_configuration/vscode.md index b369b83528d..f98accd5ac1 100644 --- a/docs/app/docs/ide_configuration/vscode.md +++ b/docs/app/docs/ide_configuration/vscode.md @@ -48,7 +48,7 @@ Once Direnv is installed and setup with Devbox, its [VSCode extension](vscode:ex ___ Devbox CLI is not supported on Windows, but you can still use it with VSCode by using Windows Subsystem for Linux ([WSL](https://learn.microsoft.com/en-us/windows/wsl/install)). If you've set up WSL, follow these steps to integrate your Devbox shell environment with VSCode: -1. [Install](https://www.jetify.com/devbox/docs/installing_devbox/) Devbox in WSL. +1. [Install](https://www.jetify.com/docs/devbox/installing_devbox/) Devbox in WSL. 2. Navigate to your project directory. (`C:\Users` is `/mnt/c/Users/` in WSL). 3. Run `devbox init` if you don't have a devbox.json file. 4. Run `devbox shell` diff --git a/docs/app/docs/quickstart.mdx b/docs/app/docs/quickstart.mdx index 2f3465537b6..2f043ec227f 100644 --- a/docs/app/docs/quickstart.mdx +++ b/docs/app/docs/quickstart.mdx @@ -174,10 +174,10 @@ Once you publish your Devbox project to Github, you can help other developers ge ### Boost your dev environment with Jetify Cloud -* **[Jetify Secrets](/cloud/docs/secrets/):** Securely store and access your secrets and environment variables in your Devbox projects. -* **[Jetify Deploys](/cloud/docs/deploys/):** Deploy your Devbox projects as autoscaling services with a single command. -* **[Jetify Cache](/cloud/docs/cache/):** Share and cache packages across all your Devbox projects and environments. -* **[Jetify Prebuilt Cache](/cloud/docs/cache/prebuilt_cache):** Use the Jetify Public Cache to speed up your Devbox builds and share packages with the community. +* **[Jetify Devspace](/cloud/devspace):** Develop any where with Devbox-powered Cloud Dev Environments +* **[Jetify Secrets](/cloud/secrets/):** Securely store and access your secrets and environment variables in your Devbox projects. +* **[Jetify Cache](/cloud/cache/):** Share and cache packages across all your Devbox projects and environments. +* **[Jetify Prebuilt Cache](/cloud/cache/prebuilt_cache):** Use the Jetify Public Cache to speed up your Devbox builds and share packages with the community. ### Get Involved * **[Join our Discord Community](https://discord.gg/jetify):** Chat with the development team and our growing community of Devbox users.