Jetify Sandbox Docs Draft

README.md

@@ -16,13 +16,13 @@
 
 In practice, Devbox works similar to a package manager like `yarn` – except the packages it manages are at the operating-system level (the sort of thing you would normally install with `brew` or `apt-get`). With Devbox, you can install over [400,000 package versions](https://www.nixhub.io) from the Nix Package Registry
 
-Devbox was originally developed by [Jetify](https://www.jetify.com) and is internally powered by `nix`. 
+Devbox was originally developed by [Jetify](https://www.jetify.com) and is internally powered by `nix`.
 
 ## Demo
 
 You can try out Devbox in your browser using the button below:
 
-[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/new)
+[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/tutorial)
 
 The example below creates a development environment with `python 2.7` and `go 1.18`, even though those packages are not installed in the underlying machine:
 

docs/app/.envrc

@@ -0,0 +1,7 @@
+# Automatically sets up your devbox environment whenever you cd into this
+# directory via our direnv integration:
+
+eval "$(devbox generate direnv --print-envrc)"
+
+# check out https://www.jetpack.io/devbox/docs/ide_configuration/direnv/
+# for more details

docs/app/docs/cloud/dashboard/creating_your_team.md → docs/app/cloud/dashboard/creating_your_team.md

@@ -13,13 +13,13 @@ Users with a free account can upgrade to a paid team on the dashboard anytime.
 
 1. From the Team Selector in the top right of your dashboard, select **Create a New Team**
 
-![New Team](../../../static/img/team_selector.png)
+![New Team](../../static/img/team_selector.png)
 
 1. You may be prompted to sign in again. Log in with the same email or Google Account that you used to create your Account.
 
 1. At the bottom of the team selection screen, enter your new Team Name and then click **Create Team**
 
-![Create Team Form](../../../static/img/create_team_form.png)
+![Create Team Form](../../static/img/create_team_form.png)
 
 1. Your new team will be created, and you will be automatically switched to your new team. You can now [invite other members](./inviting_members.md) to join your team.
 

docs/app/docs/cloud/dashboard/index.md → docs/app/cloud/dashboard/index.md

@@ -5,7 +5,7 @@ sidebar_position: 1
 
 The [Jetify Dashboard](https://cloud.jetify.com) lets you manage your team, projects, and secrets from a single interface. You can use the Dashboard to manage your own hobby projects, or to collaborate with other team members.
 
-![Jetify Dashboard](../../../static/img/jetify_cloud_dashboard.jpeg)
+![Jetify Dashboard](../../static/img/jetify_cloud_dashboard.jpeg)
 
 You can visit the Jetify Dashboard at [cloud.jetify.com](https://cloud.jetify.com)
 

docs/app/docs/cloud/dashboard/inviting_members.md → docs/app/cloud/dashboard/inviting_members.md

@@ -18,21 +18,21 @@ Team members can be added in one of two Roles:
 
 1. In the Jetify Dashboard, navigate to the **Members** tab
 
-   ![Members Tab](../../../static/img/members_tab.png)
+   ![Members Tab](../../static/img/members_tab.png)
 
 2 . To invite a member, enter their email address, and the **Role** you want to assign to them.
 
-![Inviting a Member](../../../static/img/inviting_member.png)
+![Inviting a Member](../../static/img/inviting_member.png)
 
 1. Once invited, users will receive an email with instructions on how to join your team. They will show up in the **Members** tab as invited until they accept the invitation:
 
-   ![Invited Member](../../../static/img/invited_member.png)
+   ![Invited Member](../../static/img/invited_member.png)
 
    Note that invitations will expire if they are not accepted within 7 days, after which you will need to re-send the invitation.
 
    Once they accept the invitation, they will switch to **active**
 
-   ![Active Member](../../../static/img/active_member.png)
+   ![Active Member](../../static/img/active_member.png)
 
 ## Removing a Team Member
 
@@ -42,6 +42,6 @@ Removing a team member will remove their access to all projects and secrets in y
 2. Click the Options button to the right of the the member’s name
 3. Select Delete from the pop up that appears:
 
-![Delete a member](../../../static/img/delete_member.png)
+![Delete a member](../../static/img/delete_member.png)
 
 1. Click **OK** on the confirmation window that appears to confirm that you want to remove the member from your team

docs/app/docs/cloud/deploys/custom_domains.md → docs/app/cloud/deploys/custom_domains.md

@@ -15,13 +15,13 @@ You will need access to the DNS records for your Domain in order to configure it
 
 1. In your project on the Jetify Cloud Dashboard, select **Settings**
 1. Scroll down to the **Custom Domain** section on the settings page
-   ![Custom Domain Section](../../../static/img/custom-domain.png) 
+   ![Custom Domain Section](../../static/img/custom-domain.png)
 1. Enter the custom domain name that you would like to use for your project
 1. After you click confirm, your custom domain will be set in a pending state. To validate the domain, you will need to add a record to your DNS provider:
-   ![Pending custom domain](../../../static/img/custom-domain-unknown.png)
+   ![Pending custom domain](../../static/img/custom-domain-unknown.png)
 1. Once the correct records have been added to your DNS provider, your Custom Domain will display an **Issued** status:
-    ![Custom Domain Issued](../../../static/img/custom-domain-issued.png)
+    ![Custom Domain Issued](../../static/img/custom-domain-issued.png)
 
 ## Removing a Custom Domain
 
-You can remove a custom domain by clicking the Delete button. This will remove the domain from your project. Note that after removing the domain, you may want to also clean up your DNS records. 
+You can remove a custom domain by clicking the Delete button. This will remove the domain from your project. Note that after removing the domain, you may want to also clean up your DNS records.

docs/app/docs/cloud/deploys/integrations/s3.md → docs/app/cloud/deploys/integrations/s3.md

@@ -2,7 +2,7 @@
 title: Object Storage with AWS S3
 ---
 
-[Amazon S3](https://aws.amazon.com/s3/) is an industry leading cloud object storage solution. You can use S3 to store files, media assets, and other objects that are not well suited to storage in a database or KV store. 
+[Amazon S3](https://aws.amazon.com/s3/) is an industry leading cloud object storage solution. You can use S3 to store files, media assets, and other objects that are not well suited to storage in a database or KV store.
 
 You can view an example of this integration on [Github](https://github.com/jetify-com/jetify-deploy-integration/tree/main/devbox-json/s3)
 
@@ -14,19 +14,19 @@ If you don't already have an S3 bucket configured, you will need an [AWS account
 2. On the S3 Dashboard, click **Create Bucket**, and give your bucket a name and default region
 3. If your files do not need to be accessed by external, public users, leave the **Block all Public Access** button checked. Otherwise configure the permissions to match your needs
 4. Once you've finished configuring the bucket, click **Create Bucket**
-5. Copy the ARN and save it somewhere secure. 
+5. Copy the ARN and save it somewhere secure.
 
 Once the bucket is created, you'll also need to configure [Bucket Access Policies](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) and an [IAM User Policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/walkthrough1.html) to allow your user to securely access the bucket. Consult the S3 documentation for more details on how to configure the correct policy for your needs.
 
 ## Connecting Jetify Cloud to your S3 Account
 
 If you want your Jetify Cloud App to push and pull objects from your S3 Bucket, you can use Jetify Secrets to set your AWS Access Key ID and Secret in your environment:
 
-* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment: 
+* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment:
   * `AWS_ACCESS_KEY_ID`: The access key for your AWS account
   * `AWS_SECRET_ACCESS_KEY`: The secret key for your AWS account
   * `AWS_BUCKET`: The name of the bucket that you will be accessing.
 
-![S3 Jetify Secrets](../../../../static/img/s3-secrets.png)
+![S3 Jetify Secrets](../../../static/img/s3-secrets.png)
 
-When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can use these secrets with any AWS client library (such as boto3 for Python) or via the AWS CLI/SDK itself.
+When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can use these secrets with any AWS client library (such as boto3 for Python) or via the AWS CLI/SDK itself.

docs/app/docs/cloud/deploys/integrations/supabase.md → docs/app/cloud/deploys/integrations/supabase.md

@@ -11,30 +11,30 @@ You can view an example of this integration on [Github](https://github.com/jetif
 
 If you don't have one already, you will first need to create an organization and project in Supabase to use with Jetify Cloud. If you are just testing Supabase with Jetify, you can create a free personal organization to start. For more details, see the [Supabase Docs](https://supabase.com/docs)
 
-If you plan to connect using PostgreSQL connection parameters, make sure that you save your Database password at creation time since you may need it to connect. 
+If you plan to connect using PostgreSQL connection parameters, make sure that you save your Database password at creation time since you may need it to connect.
 
 ## Connecting using the Supabase API or Clients
 
-The simplest way to connect to Supabase is via the API or one of Supabase's client libraries. Connecting via the API also lets you use Supabase's advanced realtime and streaming features. 
+The simplest way to connect to Supabase is via the API or one of Supabase's client libraries. Connecting via the API also lets you use Supabase's advanced realtime and streaming features.
 
-To connect using the API: 
+To connect using the API:
 
 * From your Supabase Project Dashboard, navigate to **Project Settings**, then **API**
 * In the API Settings pane, copy the Project URL and Secret Service Role key
-![Supabase API UI](../../../../static/img/supabase-API.png)
-* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment: 
+![Supabase API UI](../../../static/img/supabase-API.png)
+* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment:
   * `SUPABASE_URL`: the Project URL for your Supabase DB
   * `SUPABASE_KEY`: the secret Service Role Key
 
 :::info
  If you want to use your Database locally or in a preview environment, you can also set these environment variables for the `dev` and `preview` environment
 :::
 
-![Secrets set in the Jetify Cloud](../../../../static/img/supabase-secrets.png)
+![Secrets set in the Jetify Cloud](../../../static/img/supabase-secrets.png)
 
-When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can use these environment variables when configuring your Supabase client. 
+When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can use these environment variables when configuring your Supabase client.
 
-For example, if you are connecting from a Python app, you can do something like the following to connect with the Supabase Python client: 
+For example, if you are connecting from a Python app, you can do something like the following to connect with the Supabase Python client:
 
 ```python
 from supabase import create_client, Client
@@ -52,15 +52,15 @@ You can also connect to your database using the standard PostgreSQL Database con
 To connect via PostgreSQL:
 
 * From your Supabase Project Dashboard, navigate to Project Settings, then Database.
-* In the Connection Parameters Settings, copy values needed for connection. Your database password will be the password you set when creating your project. 
-![Supabase Connection Parameters](../../../../static/img/connection_parameters.png)
+* In the Connection Parameters Settings, copy values needed for connection. Your database password will be the password you set when creating your project.
+![Supabase Connection Parameters](../../../static/img/connection_parameters.png)
 
-* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment: 
+* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment:
   * `POSTGRES_HOST`: Your PostgreSQL Host
   * `POSTGRES_PORT`: Your PostgreSQL DB Port
   * `POSTGRES_USER`: Your PostgreSQL Username
   * `POSTGRES_PASSWORD`: Your PostgreSQL Database Password
 
-![Postgres Secrets](../../../../static/img/postgres-secrets.png)
- 
-When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can use these environment variables when configuring your PostgreSQL client or connection.  
+![Postgres Secrets](../../../static/img/postgres-secrets.png)
+
+When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can use these environment variables when configuring your PostgreSQL client or connection.

docs/app/docs/cloud/deploys/integrations/upstash.md → docs/app/cloud/deploys/integrations/upstash.md

@@ -11,22 +11,22 @@ You can view an example of this integration on [Github](https://github.com/jetif
 
 * [Create a Redis Database](https://upstash.com/docs/redis/overall/getstarted) in Upstash. Select the Database's name and region, and then click the Create button
   * If you don't already have an Upstash account, you can create a free one to test with Jetify Cloud
-* After clicking the Create button, you'll see a page with the connection details for your Database. Copy the Endpoint, Password, and Port -- you'll need these to connect from Jetify Cloud. 
+* After clicking the Create button, you'll see a page with the connection details for your Database. Copy the Endpoint, Password, and Port -- you'll need these to connect from Jetify Cloud.
 
-![Upstash Dashboard after clicking Create](../../../../static/img/upstash.png)
+![Upstash Dashboard after clicking Create](../../../static/img/upstash.png)
 
-* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment: 
+* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment:
   * `REDIS_HOST`: your Upstash DB Endpoint URL
   * `REDIS_PASSWORD`: your Upstash DB Password
-  * `REDIS_PORT`: your Upstash DB Port 
+  * `REDIS_PORT`: your Upstash DB Port
 
 :::info
  If you want to use your Database locally or in a preview environment, you can also set these environment variables for the `dev` and `preview` environment
 :::
 
-![Secrets set in the Jetify Cloud](../../../../static/img/upstash-secrets.png)
+![Secrets set in the Jetify Cloud](../../../static/img/upstash-secrets.png)
 
-When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can then access them using any redis client. 
+When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can then access them using any redis client.
 
 For example, if you are connecting from a Python app, you can do something like the following to connect from a Redis client.
 
@@ -40,4 +40,4 @@ redis_cache = redis.StrictRedis(
     port=os.getenv('REDIS_PORT'),
     ssl=True
 )
-```
+```

docs/app/docs/cloud/deploys/monitoring_deploys.md → docs/app/cloud/deploys/monitoring_deploys.md

@@ -9,22 +9,22 @@ Jetify Cloud automatically provides build and runtime logs for each of your depl
 
 Build logs include all the logs generated when cloning, building, and uploading your project to Jetify's Docker Registry. You can check the build logs to see why a build or deployment failed, or to identify bottlenecks in the build process. Build logs automatically stream in realtime.
 
-You can view the build logs for a specific deployment by selecting the deployment, and then expanding the Build logs section 
+You can view the build logs for a specific deployment by selecting the deployment, and then expanding the Build logs section
 
-![Build logs](../../../static/img/deploy-in-progress.png)
+![Build logs](../../static/img/deploy-in-progress.png)
 
 ## Runtime Logs
 
-Runtime logs capture everything that has happened in your application after it is deployed to the Jetify Cloud. You can use these logs to for testing and debugging server-side errors, or for understanding why a given deployment has failed to start. 
+Runtime logs capture everything that has happened in your application after it is deployed to the Jetify Cloud. You can use these logs to for testing and debugging server-side errors, or for understanding why a given deployment has failed to start.
 
 Runtime logs stream in realtime, and Devbox retains the last 24 hours of runtime logs for each of your deployments.
 
 You can view your Runtime Logs by clicking the **Runtime Logs** tab in your Deployment Details page:
 
-![Runtime Logs](../../../static/img/runtime-logs.png)
+![Runtime Logs](../../static/img/runtime-logs.png)
 
 ## Preview URL
 
-In addition to build and runtime logs, Jetify Cloud automatically generates a randomized preview URL that you can use to test your application, or to share a preview of the deployment with other users and developers. Each deployment receives a unique preview URL. 
+In addition to build and runtime logs, Jetify Cloud automatically generates a randomized preview URL that you can use to test your application, or to share a preview of the deployment with other users and developers. Each deployment receives a unique preview URL.
 
-To preview your deployment, click the **View** button on the Deployment Details page. 
+To preview your deployment, click the **View** button on the Deployment Details page.

docs/app/docs/cloud/deploys/setup.md → docs/app/cloud/deploys/setup.md

@@ -53,18 +53,18 @@ If your repo contains a Dockerfile, Jetify Cloud will use that Dockerfile to dep
 
 ## Connecting your Repo
 
-Jetify requires you to connect a Github repo in order to deploy your service. To access private repositories, you will need to install the Devbox Cloud Github app in your repository: 
+Jetify requires you to connect a Github repo in order to deploy your service. To access private repositories, you will need to install the Devbox Cloud Github app in your repository:
 
 1. From the Create Project screen, select Continue with Github to sign in with Github
-2. Select a Github Org to import your project from. If you are only a member of one org, it will be selected for you by default. 
+2. Select a Github Org to import your project from. If you are only a member of one org, it will be selected for you by default.
    1. If this is your first time importing a project from your org, you will need to install the Devbox Cloud app to provide access to your project
-3. Select a Repository to import your repo. If your project is not in the root directory of your repository, you can specify a subdirectory for Jetify to search for your project. 
+3. Select a Repository to import your repo. If your project is not in the root directory of your repository, you can specify a subdirectory for Jetify to search for your project.
 
-![Select the Repo for your Jetify Project](../../../static/img/newproject-tworepos.png)
+![Select the Repo for your Jetify Project](../../static/img/newproject-tworepos.png)
 
 ## Choosing an Instance Size
 
-Jetify will default your deployment to the smallest instance size (0.1 CPU + 512MB RAM). To choose a different size: 
+Jetify will default your deployment to the smallest instance size (0.1 CPU + 512MB RAM). To choose a different size:
 
 1. Navigate to the **Settings** tab of your project
 2. Scroll down to **Deployments**

docs/app/cloud/devspace/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Jetify Devspace",
+  "position": 1
+}