From e74c8938a1a0ac97b9bee98e0330ed7f729a8d20 Mon Sep 17 00:00:00 2001 From: John Lago <750845+Lagoja@users.noreply.github.com> Date: Thu, 5 Sep 2024 19:29:36 -0700 Subject: [PATCH] Reorganize into and --- docs/app/{docs => }/cloud/_category_.json | 0 .../{docs => }/cloud/cache/authenticating.md | 0 docs/app/{docs => }/cloud/cache/index.md | 0 .../{docs => }/cloud/cache/prebuilt_cache.md | 0 docs/app/{docs => }/cloud/cache/usage.md | 0 .../cloud/dashboard/_category_.json | 0 .../cloud/dashboard/creating_your_team.md | 4 +-- docs/app/{docs => }/cloud/dashboard/index.md | 2 +- .../cloud/dashboard/inviting_members.md | 10 +++---- .../{docs => }/cloud/deploys/_category_.json | 0 .../cloud/deploys/custom_domains.md | 8 +++--- docs/app/{docs => }/cloud/deploys/index.md | 0 .../deploys/integrations/_category_.json | 0 .../cloud/deploys/integrations/index.md | 0 .../cloud/deploys/integrations/s3.md | 10 +++---- .../cloud/deploys/integrations/supabase.md | 28 +++++++++---------- .../cloud/deploys/integrations/upstash.md | 14 +++++----- .../cloud/deploys/monitoring_deploys.md | 12 ++++---- docs/app/{docs => }/cloud/deploys/secrets.md | 0 docs/app/{docs => }/cloud/deploys/setup.md | 10 +++---- docs/app/{docs => }/cloud/faq.md | 0 docs/app/{docs => }/cloud/index.md | 0 .../cloud/sandboxes/_category_.json | 0 docs/app/{docs => }/cloud/sandboxes/faq.md | 0 docs/app/{docs => }/cloud/sandboxes/index.md | 0 .../cloud/sandboxes/link_sandboxes.md | 0 .../cloud/sandboxes/managing_sandboxes.md | 0 .../{docs => }/cloud/sandboxes/quickstart.md | 17 ++++++----- .../cloud/sandboxes/start_a_sandbox.md | 2 +- .../cloud/sandboxes/team_sandboxes.md | 0 .../{docs => }/cloud/secrets/_category_.json | 0 .../cloud/secrets/dashboard_secrets.md | 4 +-- docs/app/{docs => }/cloud/secrets/index.md | 2 +- .../{docs => }/cloud/secrets/secrets_cli.md | 4 +-- docs/app/{docs => }/cloud/sidebar.ts | 12 ++++---- docs/app/cloud_sidebars.js | 23 +++++++++++++++ docs/app/docs/contributor-quickstart.md | 8 +++--- docs/app/docs/faq.md | 26 ++++++++--------- docs/app/docs/guides/using_flakes.md | 4 +-- docs/app/docs/quickstart.mdx | 8 +++--- docs/app/docusaurus.config.js | 20 +++++++++---- docs/app/sidebars.js | 2 -- 42 files changed, 130 insertions(+), 100 deletions(-) rename docs/app/{docs => }/cloud/_category_.json (100%) rename docs/app/{docs => }/cloud/cache/authenticating.md (100%) rename docs/app/{docs => }/cloud/cache/index.md (100%) rename docs/app/{docs => }/cloud/cache/prebuilt_cache.md (100%) rename docs/app/{docs => }/cloud/cache/usage.md (100%) rename docs/app/{docs => }/cloud/dashboard/_category_.json (100%) rename docs/app/{docs => }/cloud/dashboard/creating_your_team.md (92%) rename docs/app/{docs => }/cloud/dashboard/index.md (88%) rename docs/app/{docs => }/cloud/dashboard/inviting_members.md (85%) rename docs/app/{docs => }/cloud/deploys/_category_.json (100%) rename docs/app/{docs => }/cloud/deploys/custom_domains.md (85%) rename docs/app/{docs => }/cloud/deploys/index.md (100%) rename docs/app/{docs => }/cloud/deploys/integrations/_category_.json (100%) rename docs/app/{docs => }/cloud/deploys/integrations/index.md (100%) rename docs/app/{docs => }/cloud/deploys/integrations/s3.md (90%) rename docs/app/{docs => }/cloud/deploys/integrations/supabase.md (83%) rename docs/app/{docs => }/cloud/deploys/integrations/upstash.md (82%) rename docs/app/{docs => }/cloud/deploys/monitoring_deploys.md (83%) rename docs/app/{docs => }/cloud/deploys/secrets.md (100%) rename docs/app/{docs => }/cloud/deploys/setup.md (93%) rename docs/app/{docs => }/cloud/faq.md (100%) rename docs/app/{docs => }/cloud/index.md (100%) rename docs/app/{docs => }/cloud/sandboxes/_category_.json (100%) rename docs/app/{docs => }/cloud/sandboxes/faq.md (100%) rename docs/app/{docs => }/cloud/sandboxes/index.md (100%) rename docs/app/{docs => }/cloud/sandboxes/link_sandboxes.md (100%) rename docs/app/{docs => }/cloud/sandboxes/managing_sandboxes.md (100%) rename docs/app/{docs => }/cloud/sandboxes/quickstart.md (80%) rename docs/app/{docs => }/cloud/sandboxes/start_a_sandbox.md (87%) rename docs/app/{docs => }/cloud/sandboxes/team_sandboxes.md (100%) rename docs/app/{docs => }/cloud/secrets/_category_.json (100%) rename docs/app/{docs => }/cloud/secrets/dashboard_secrets.md (92%) rename docs/app/{docs => }/cloud/secrets/index.md (97%) rename docs/app/{docs => }/cloud/secrets/secrets_cli.md (97%) rename docs/app/{docs => }/cloud/sidebar.ts (85%) create mode 100644 docs/app/cloud_sidebars.js diff --git a/docs/app/docs/cloud/_category_.json b/docs/app/cloud/_category_.json similarity index 100% rename from docs/app/docs/cloud/_category_.json rename to docs/app/cloud/_category_.json diff --git a/docs/app/docs/cloud/cache/authenticating.md b/docs/app/cloud/cache/authenticating.md similarity index 100% rename from docs/app/docs/cloud/cache/authenticating.md rename to docs/app/cloud/cache/authenticating.md diff --git a/docs/app/docs/cloud/cache/index.md b/docs/app/cloud/cache/index.md similarity index 100% rename from docs/app/docs/cloud/cache/index.md rename to docs/app/cloud/cache/index.md diff --git a/docs/app/docs/cloud/cache/prebuilt_cache.md b/docs/app/cloud/cache/prebuilt_cache.md similarity index 100% rename from docs/app/docs/cloud/cache/prebuilt_cache.md rename to docs/app/cloud/cache/prebuilt_cache.md diff --git a/docs/app/docs/cloud/cache/usage.md b/docs/app/cloud/cache/usage.md similarity index 100% rename from docs/app/docs/cloud/cache/usage.md rename to docs/app/cloud/cache/usage.md diff --git a/docs/app/docs/cloud/dashboard/_category_.json b/docs/app/cloud/dashboard/_category_.json similarity index 100% rename from docs/app/docs/cloud/dashboard/_category_.json rename to docs/app/cloud/dashboard/_category_.json diff --git a/docs/app/docs/cloud/dashboard/creating_your_team.md b/docs/app/cloud/dashboard/creating_your_team.md similarity index 92% rename from docs/app/docs/cloud/dashboard/creating_your_team.md rename to docs/app/cloud/dashboard/creating_your_team.md index e04d5a7c7d0..2727be1081d 100644 --- a/docs/app/docs/cloud/dashboard/creating_your_team.md +++ b/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. diff --git a/docs/app/docs/cloud/dashboard/index.md b/docs/app/cloud/dashboard/index.md similarity index 88% rename from docs/app/docs/cloud/dashboard/index.md rename to docs/app/cloud/dashboard/index.md index c6be6cd66b7..1a9ecad3249 100644 --- a/docs/app/docs/cloud/dashboard/index.md +++ b/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) diff --git a/docs/app/docs/cloud/dashboard/inviting_members.md b/docs/app/cloud/dashboard/inviting_members.md similarity index 85% rename from docs/app/docs/cloud/dashboard/inviting_members.md rename to docs/app/cloud/dashboard/inviting_members.md index 49b34e204cc..5631e45a0c1 100644 --- a/docs/app/docs/cloud/dashboard/inviting_members.md +++ b/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 diff --git a/docs/app/docs/cloud/deploys/_category_.json b/docs/app/cloud/deploys/_category_.json similarity index 100% rename from docs/app/docs/cloud/deploys/_category_.json rename to docs/app/cloud/deploys/_category_.json diff --git a/docs/app/docs/cloud/deploys/custom_domains.md b/docs/app/cloud/deploys/custom_domains.md similarity index 85% rename from docs/app/docs/cloud/deploys/custom_domains.md rename to docs/app/cloud/deploys/custom_domains.md index de2ae31d94e..710624f2f94 100644 --- a/docs/app/docs/cloud/deploys/custom_domains.md +++ b/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. \ No newline at end of file +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. diff --git a/docs/app/docs/cloud/deploys/index.md b/docs/app/cloud/deploys/index.md similarity index 100% rename from docs/app/docs/cloud/deploys/index.md rename to docs/app/cloud/deploys/index.md diff --git a/docs/app/docs/cloud/deploys/integrations/_category_.json b/docs/app/cloud/deploys/integrations/_category_.json similarity index 100% rename from docs/app/docs/cloud/deploys/integrations/_category_.json rename to docs/app/cloud/deploys/integrations/_category_.json diff --git a/docs/app/docs/cloud/deploys/integrations/index.md b/docs/app/cloud/deploys/integrations/index.md similarity index 100% rename from docs/app/docs/cloud/deploys/integrations/index.md rename to docs/app/cloud/deploys/integrations/index.md diff --git a/docs/app/docs/cloud/deploys/integrations/s3.md b/docs/app/cloud/deploys/integrations/s3.md similarity index 90% rename from docs/app/docs/cloud/deploys/integrations/s3.md rename to docs/app/cloud/deploys/integrations/s3.md index ced580ed732..d215ad0eb9b 100644 --- a/docs/app/docs/cloud/deploys/integrations/s3.md +++ b/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,7 +14,7 @@ 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. @@ -22,11 +22,11 @@ Once the bucket is created, you'll also need to configure [Bucket Access Policie 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. \ No newline at end of file +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. diff --git a/docs/app/docs/cloud/deploys/integrations/supabase.md b/docs/app/cloud/deploys/integrations/supabase.md similarity index 83% rename from docs/app/docs/cloud/deploys/integrations/supabase.md rename to docs/app/cloud/deploys/integrations/supabase.md index d920f85d43b..21b349040ba 100644 --- a/docs/app/docs/cloud/deploys/integrations/supabase.md +++ b/docs/app/cloud/deploys/integrations/supabase.md @@ -11,18 +11,18 @@ 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 @@ -30,11 +30,11 @@ To connect using the API: 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. \ No newline at end of file +![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. diff --git a/docs/app/docs/cloud/deploys/integrations/upstash.md b/docs/app/cloud/deploys/integrations/upstash.md similarity index 82% rename from docs/app/docs/cloud/deploys/integrations/upstash.md rename to docs/app/cloud/deploys/integrations/upstash.md index 8bdedfb0dcd..8e31f13e81d 100644 --- a/docs/app/docs/cloud/deploys/integrations/upstash.md +++ b/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 ) -``` \ No newline at end of file +``` diff --git a/docs/app/docs/cloud/deploys/monitoring_deploys.md b/docs/app/cloud/deploys/monitoring_deploys.md similarity index 83% rename from docs/app/docs/cloud/deploys/monitoring_deploys.md rename to docs/app/cloud/deploys/monitoring_deploys.md index 9b9dff76aa1..eaaf702d393 100644 --- a/docs/app/docs/cloud/deploys/monitoring_deploys.md +++ b/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. \ No newline at end of file +To preview your deployment, click the **View** button on the Deployment Details page. diff --git a/docs/app/docs/cloud/deploys/secrets.md b/docs/app/cloud/deploys/secrets.md similarity index 100% rename from docs/app/docs/cloud/deploys/secrets.md rename to docs/app/cloud/deploys/secrets.md diff --git a/docs/app/docs/cloud/deploys/setup.md b/docs/app/cloud/deploys/setup.md similarity index 93% rename from docs/app/docs/cloud/deploys/setup.md rename to docs/app/cloud/deploys/setup.md index 86d3616a8f0..02865160267 100644 --- a/docs/app/docs/cloud/deploys/setup.md +++ b/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** diff --git a/docs/app/docs/cloud/faq.md b/docs/app/cloud/faq.md similarity index 100% rename from docs/app/docs/cloud/faq.md rename to docs/app/cloud/faq.md diff --git a/docs/app/docs/cloud/index.md b/docs/app/cloud/index.md similarity index 100% rename from docs/app/docs/cloud/index.md rename to docs/app/cloud/index.md diff --git a/docs/app/docs/cloud/sandboxes/_category_.json b/docs/app/cloud/sandboxes/_category_.json similarity index 100% rename from docs/app/docs/cloud/sandboxes/_category_.json rename to docs/app/cloud/sandboxes/_category_.json diff --git a/docs/app/docs/cloud/sandboxes/faq.md b/docs/app/cloud/sandboxes/faq.md similarity index 100% rename from docs/app/docs/cloud/sandboxes/faq.md rename to docs/app/cloud/sandboxes/faq.md diff --git a/docs/app/docs/cloud/sandboxes/index.md b/docs/app/cloud/sandboxes/index.md similarity index 100% rename from docs/app/docs/cloud/sandboxes/index.md rename to docs/app/cloud/sandboxes/index.md diff --git a/docs/app/docs/cloud/sandboxes/link_sandboxes.md b/docs/app/cloud/sandboxes/link_sandboxes.md similarity index 100% rename from docs/app/docs/cloud/sandboxes/link_sandboxes.md rename to docs/app/cloud/sandboxes/link_sandboxes.md diff --git a/docs/app/docs/cloud/sandboxes/managing_sandboxes.md b/docs/app/cloud/sandboxes/managing_sandboxes.md similarity index 100% rename from docs/app/docs/cloud/sandboxes/managing_sandboxes.md rename to docs/app/cloud/sandboxes/managing_sandboxes.md diff --git a/docs/app/docs/cloud/sandboxes/quickstart.md b/docs/app/cloud/sandboxes/quickstart.md similarity index 80% rename from docs/app/docs/cloud/sandboxes/quickstart.md rename to docs/app/cloud/sandboxes/quickstart.md index 81b25e03c72..35b580d6a5a 100644 --- a/docs/app/docs/cloud/sandboxes/quickstart.md +++ b/docs/app/cloud/sandboxes/quickstart.md @@ -4,7 +4,7 @@ sidebar_position: 1 hide_title: false --- -Jetify Cloudboxes let you spin up reproducible cloud development environments in your browser in seconds. Jetify Cloudboxes are powered by [Devbox](../../../), so you can run your environment on any machine. You can launch any +Jetify Cloudboxes let you spin up reproducible cloud development environments in your browser in seconds. Jetify Cloudboxes are powered by [Devbox](/devbox/docs), so you can run your environment on any machine. You can launch any Let's launch our first Dev Environment with Jetify Cloudboxes. @@ -21,9 +21,8 @@ For example, to launch the [Devbox repo](https://github.com/jetify-com/devbox) i [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_examples) projects to get started + If you need some inspiration, you can also launch one of our [templates](/devbox/docs/devbox_examples) projects to get started ::: - You can also launch a new Sandbox by navigating to your [Dashboard](https://cloud.jetify.com/dashboard) and clicking on the `New Sandbox` button. ## Step 2: Customize your Sandbox with Devbox @@ -50,12 +49,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](../../../guides/scripts), [services](../../../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](/devbox/docs/guides/scripts), [services](/devbox/docs/guides/services), and more For further reading on how to install packages with Devbox, see: -* [Devbox Quickstart](../../../quickstart) -* [Devbox CLI Reference](../../../cli_reference/devbox) +* [Devbox Quickstart](/devbox/docs/quickstart) +* [Devbox CLI Reference](/devbox/docs/cli_reference/devbox) ## Step 3: Save your Dev Environment with `devbox.json` @@ -63,6 +62,6 @@ Once you've customized your environment, you can save your Dev Environment confi You can also use this file to configure initilization hooks, scripts, services, and environment variables for your project. For further reading, see: -* [Devbox Configuration Reference](../../../configuration) -* [Devbox Script](../../../guides/scripts) -* [Devbox Services](../../../guides/services) +* [Devbox Configuration Reference](/devbox/docs/configuration) +* [Devbox Script](/devbox/docs/guides/scripts) +* [Devbox Services](/devbox/docs/guides/services) diff --git a/docs/app/docs/cloud/sandboxes/start_a_sandbox.md b/docs/app/cloud/sandboxes/start_a_sandbox.md similarity index 87% rename from docs/app/docs/cloud/sandboxes/start_a_sandbox.md rename to docs/app/cloud/sandboxes/start_a_sandbox.md index 72d3c6e85d1..fa1811e7270 100644 --- a/docs/app/docs/cloud/sandboxes/start_a_sandbox.md +++ b/docs/app/cloud/sandboxes/start_a_sandbox.md @@ -18,4 +18,4 @@ https://cloud.jetify.com/new/ You can also start a Sandbox from a template project by navigating to the [Jetify Dashboard](https://cloud.jetify.com/dashboard) and clicking on the `New Sandbox` button. -A full list of available templates and projects can be found in the [Devbox Examples](../../../devbox_examples/) page of our documentation. +A full list of available templates and projects can be found in the [Devbox Examples](/devbox/docs/devbox_examples/) page of our documentation. diff --git a/docs/app/docs/cloud/sandboxes/team_sandboxes.md b/docs/app/cloud/sandboxes/team_sandboxes.md similarity index 100% rename from docs/app/docs/cloud/sandboxes/team_sandboxes.md rename to docs/app/cloud/sandboxes/team_sandboxes.md diff --git a/docs/app/docs/cloud/secrets/_category_.json b/docs/app/cloud/secrets/_category_.json similarity index 100% rename from docs/app/docs/cloud/secrets/_category_.json rename to docs/app/cloud/secrets/_category_.json diff --git a/docs/app/docs/cloud/secrets/dashboard_secrets.md b/docs/app/cloud/secrets/dashboard_secrets.md similarity index 92% rename from docs/app/docs/cloud/secrets/dashboard_secrets.md rename to docs/app/cloud/secrets/dashboard_secrets.md index 24c498bd2a8..9a440ed8de2 100644 --- a/docs/app/docs/cloud/secrets/dashboard_secrets.md +++ b/docs/app/cloud/secrets/dashboard_secrets.md @@ -16,7 +16,7 @@ To manage secrets from the Jetify Cloud Dashboard, you must first: 1. From the Jetify Dashboard, select the project whose secrets you want to manage 1. Navigate to the Secrets tab of the Jetify Dashboard - ![Jetify Dashboard Secrets Tab](../../../static/img/secrets_tab.png) + ![Jetify Dashboard Secrets Tab](../../static/img/secrets_tab.png) 1. To create a new secret, enter the key name of the secret, along with the value that you want to set in the form. Note that secrets are set as environment variables, so the key name must be a valid environment variable name. 1. You can also use the Environment checkboxes to set the secret for a specific environment. By default, secrets are set for the `Development` environment, but you can also set secrets for a `Preview` and `Prod` environment. 1. To add multiple secrets at one time, click the **Add Another** button @@ -26,7 +26,7 @@ To manage secrets from the Jetify Cloud Dashboard, you must first: You can update or manage secrets by clicking the edit button next to the secret that you want to update. This will open a modal where you can update the value of the secret, or delete the secret entirely. -![Editing Secrets](../../../static/img/edit_secrets.png) +![Editing Secrets](../../static/img/edit_secrets.png) ## Further Reading diff --git a/docs/app/docs/cloud/secrets/index.md b/docs/app/cloud/secrets/index.md similarity index 97% rename from docs/app/docs/cloud/secrets/index.md rename to docs/app/cloud/secrets/index.md index 8e9e3987074..e9b7f988d3e 100644 --- a/docs/app/docs/cloud/secrets/index.md +++ b/docs/app/cloud/secrets/index.md @@ -5,7 +5,7 @@ sidebar_position: 1 Jetify Secrets is a secure secrets management service that lets you store and access secrets for your projects. Secrets are encrypted and stored in the cloud, and are automatically accessed by your project’s Devbox environment whenever you start a shell, run a script, or start a service. -![Using Devbox Secrets](../../../static/img/secrets.gif) +![Using Devbox Secrets](../../static/img/secrets.gif) ## Key Concepts diff --git a/docs/app/docs/cloud/secrets/secrets_cli.md b/docs/app/cloud/secrets/secrets_cli.md similarity index 97% rename from docs/app/docs/cloud/secrets/secrets_cli.md rename to docs/app/cloud/secrets/secrets_cli.md index a3f9c102bb8..eb817dba20d 100644 --- a/docs/app/docs/cloud/secrets/secrets_cli.md +++ b/docs/app/cloud/secrets/secrets_cli.md @@ -11,7 +11,7 @@ If you don't already have Devbox installed, see our [Quickstart](https://www.jet You can authenticate with Jetify Cloud by running `devbox secrets auth login`. This will launch the browser authentication flow to sign into Jetify Cloud. -![Auth Page](../../../static/img/jetify_auth.jpeg) +![Auth Page](../../static/img/jetify_auth.jpeg) Once you complete the authentication flow and select a team, the Devbox CLI will configure itself to use the team you selected @@ -134,5 +134,5 @@ You can download from a specific environment using the `--environment` flag: ## Further Reading -- [Devbox Secrets CLI Reference](../../cli_reference/devbox_secrets.md) +- [Devbox Secrets CLI Reference](/devbox/docs/cli_reference/devbox_secrets) - [Managing Secrets from the Dashboard](../dashboard_secrets) diff --git a/docs/app/docs/cloud/sidebar.ts b/docs/app/cloud/sidebar.ts similarity index 85% rename from docs/app/docs/cloud/sidebar.ts rename to docs/app/cloud/sidebar.ts index e35c96bb2be..7b570b29fe3 100644 --- a/docs/app/docs/cloud/sidebar.ts +++ b/docs/app/cloud/sidebar.ts @@ -4,7 +4,7 @@ const cloudSidebar: SidebarsConfig = { sidebar: [ { type: "doc", - id: "cloud/index", + id: "index", }, { type: "category", @@ -13,7 +13,7 @@ const cloudSidebar: SidebarsConfig = { items: [ { type: "autogenerated", - dirName: "cloud/sandboxes", + dirName: "sandboxes", }, ], }, @@ -24,7 +24,7 @@ const cloudSidebar: SidebarsConfig = { items: [ { type: "autogenerated", - dirName: "cloud/secrets", + dirName: "secrets", }, ], }, @@ -35,7 +35,7 @@ const cloudSidebar: SidebarsConfig = { items: [ { type: "autogenerated", - dirName: "cloud/cache", + dirName: "cache", }, ], }, @@ -46,7 +46,7 @@ const cloudSidebar: SidebarsConfig = { items: [ { type: "autogenerated", - dirName: "cloud/dashboard", + dirName: "dashboard", }, ], }, @@ -62,7 +62,7 @@ const cloudSidebar: SidebarsConfig = { // }, { type: "doc", - id: "cloud/faq", + id: "faq", }, ], }; diff --git a/docs/app/cloud_sidebars.js b/docs/app/cloud_sidebars.js new file mode 100644 index 00000000000..dae19824e8e --- /dev/null +++ b/docs/app/cloud_sidebars.js @@ -0,0 +1,23 @@ +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + */ + +// @ts-check + +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const sidebars = { + // By default, Docusaurus generates a sidebar from the docs folder structure + // tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }], + + // But you can create a sidebar manually + cloudSidebar: require("./cloud/sidebar"), +}; + +export default sidebars; diff --git a/docs/app/docs/contributor-quickstart.md b/docs/app/docs/contributor-quickstart.md index ddbe7012a2b..31090c457ae 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/secrets/index.md):** Securely store and access your secrets and environment variables in your Devbox projects. -* **[Jetify Deploys](./cloud/deploys/index.md):** Deploy your Devbox projects as autoscaling services with a single command. -* **[Jetify Cache](./cloud/cache/index.md):** Share and cache packages across all your Devbox projects and environments. -* **[Jetify Prebuilt Cache](./cloud/cache/prebuilt_cache.md):** Use the Jetify Public Cache to speed up your Devbox builds and share packages with the community. +* **[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. ### 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/faq.md b/docs/app/docs/faq.md index 0ca6df6f516..f52f17068b9 100644 --- a/docs/app/docs/faq.md +++ b/docs/app/docs/faq.md @@ -31,15 +31,15 @@ Yes! Devbox can be installed on any Linux distribution, including NixOS. You can ## A package I installed is missing header files or libraries I need for development. Where do I find them? -In order to save space, Devbox and Nix only install the required components of packages by default. Development header files and libraries are often installed in a separate output of the package (usually `dev`), which can be installed using the `--output` flag on the `devbox add` command. +In order to save space, Devbox and Nix only install the required components of packages by default. Development header files and libraries are often installed in a separate output of the package (usually `dev`), which can be installed using the `--output` flag on the `devbox add` command. -For example, the command below will install both the default output `out`, and the `cli` output for the prometheus package: +For example, the command below will install both the default output `out`, and the `cli` output for the prometheus package: ```bash devbox add prometheus --outputs=out,cli ``` -You can also specify non-default outputs in [flake references](./guides/using_flakes.md): +You can also specify non-default outputs in [flake references](./guides/using_flakes.md): ```bash devbox add github:NixOS/nixpkgs#prometheus^out,cli @@ -47,36 +47,36 @@ devbox add github:NixOS/nixpkgs#prometheus^out,cli ## One of my project's packages is taking a long time to install. How can I speed up the installation process? -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. +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/cache/index.md) or the [Jetify Prebuilt Cache](./cloud/cache/prebuilt_cache.md) 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](/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. ## I'm trying to build a project, but it says that I'm missing `libstdc++`. How do I install this library in my project? -This message means that your project requires an implementation of the C++ Standard Library installed and linked within your shell. You can add the libstdc++ libraries and object files using `devbox add stdenv.cc.cc.lib`. +This message means that your project requires an implementation of the C++ Standard Library installed and linked within your shell. You can add the libstdc++ libraries and object files using `devbox add stdenv.cc.cc.lib`. ## I'm seeing a ``GLIBC_X.XX' not found` error when I try to install my packages, or when I install packages from PyPi/RubyGems/NPM/Cargo/other package manager in my shell -This message usually occurs when using older packages, or when mixing different versions of packages within a single shell. The error tends to occur because each Nix package comes bundled with all of it's dependencies, including a version of the C Standard Library, to ensure reproducibility. If your interpreter (Python/Ruby/Node) or runtime is using an older version of `glibc` than what your other packages expect, they will throw this error. +This message usually occurs when using older packages, or when mixing different versions of packages within a single shell. The error tends to occur because each Nix package comes bundled with all of it's dependencies, including a version of the C Standard Library, to ensure reproducibility. If your interpreter (Python/Ruby/Node) or runtime is using an older version of `glibc` than what your other packages expect, they will throw this error. -There are three ways to work around this issue: -1. You can update your packages to use a newer version (using `devbox add`). This newer version will likely come bundled with a newer version of `glibc`. +There are three ways to work around this issue: +1. You can update your packages to use a newer version (using `devbox add`). This newer version will likely come bundled with a newer version of `glibc`. 2. You can use `devbox update` to get the latest Nix derivation for your package. Newer derivations may come bundled with newer dependencies, including `glibc` 3. If you need to use an exact package version, but you still see this error, you can patch it to use a newer version of glibc using `devbox add @ --patch-glibc`. This will patch your package to use a newer version of glibc, which should resolve any incompatibility issues you might be seeing. **This patch will only affect packages on Linux.** ## How can I use custom Nix packages or overrides with Devbox? -You can add customized packages to your Devbox environment using our [Flake support](./guides/using_flakes.md). 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](/devbox/docs/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/)? -Yes. In addition to supporting POSIX compliant shells like Zsh and Bash, Devbox also works with Fish. +Yes. In addition to supporting POSIX compliant shells like Zsh and Bash, Devbox also works with Fish. -Note that `init_hooks` in Devbox will be run directly in your host shell, so you may have encounter some compatibility issues if you try to start a shell that uses a POSIX-compatible script in the init_hook. +Note that `init_hooks` in Devbox will be run directly in your host shell, so you may have encounter some compatibility issues if you try to start a shell that uses a POSIX-compatible script in the init_hook. ## How can I rollback to a previous version of Devbox? -You can use any previous version of Devbox by setting the `DEVBOX_USE_VERSION` environment variable. For example, to use version 0.8.0, you can run the following or add it to your shell's rcfile: +You can use any previous version of Devbox by setting the `DEVBOX_USE_VERSION` environment variable. For example, to use version 0.8.0, you can run the following or add it to your shell's rcfile: ```bash export DEVBOX_USE_VERSION=0.8.0 diff --git a/docs/app/docs/guides/using_flakes.md b/docs/app/docs/guides/using_flakes.md index c8abcfac0f4..3637770146d 100644 --- a/docs/app/docs/guides/using_flakes.md +++ b/docs/app/docs/guides/using_flakes.md @@ -93,9 +93,9 @@ 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/cache/index.md) 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](/cloud/docs/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: +After setting up your cache directly, you can upload the flake by running: ```bash devbox cache upload diff --git a/docs/app/docs/quickstart.mdx b/docs/app/docs/quickstart.mdx index 34eb96dd72e..4e4491398ee 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/secrets/index.md):** Securely store and access your secrets and environment variables in your Devbox projects. -* **[Jetify Deploys](./cloud/deploys/index.md):** Deploy your Devbox projects as autoscaling services with a single command. -* **[Jetify Cache](./cloud/cache/index.md):** Share and cache packages across all your Devbox projects and environments. -* **[Jetify Prebuilt Cache](./cloud/cache/prebuilt_cache.md):** Use the Jetify Public Cache to speed up your Devbox builds and share packages with the community. +* **[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. ### 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/docusaurus.config.js b/docs/app/docusaurus.config.js index 7f7d846c6f0..3340e6b5434 100644 --- a/docs/app/docusaurus.config.js +++ b/docs/app/docusaurus.config.js @@ -7,10 +7,10 @@ const codeTheme = { light: themes.github, dark: themes.dracula }; /** @type {import('@docusaurus/types').Config} */ const config = { - title: "Devbox", + title: "Jetify Docs", tagline: "Instant, easy, and predictable shells and containers", url: "https://www.jetify.com", - baseUrl: "/devbox/docs/", + baseUrl: "/", onBrokenLinks: "throw", onBrokenMarkdownLinks: "warn", favicon: "img/favicon.ico", @@ -38,7 +38,7 @@ const config = { /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { - routeBasePath: "/", + routeBasePath: "/devbox/docs", sidebarPath: require.resolve("./sidebars.js"), // Please change this to your repo. // Remove this to remove the "edit this page" links. @@ -59,6 +59,15 @@ const config = { ], plugins: [ + [ + "@docusaurus/plugin-content-docs", + { + id: "cloud", + path: "cloud", + routeBasePath: "/cloud/docs", + sidebarPath: require.resolve("./cloud_sidebars.js"), + }, + ], [ "docusaurus-plugin-openapi-docs", { @@ -82,16 +91,17 @@ const config = { alt: "Devbox", src: "img/devbox_logo_light.svg", srcDark: "img/devbox_logo_dark.svg", + href: "/devbox/docs", }, items: [ { - to: "cloud", + to: "cloud/docs", label: "Jetify Cloud", className: "header-text-link", position: "left", }, { - to: "nixhub", + to: "/devbox/docs/nixhub", label: "NixHub API", className: "header-text-link", position: "left", diff --git a/docs/app/sidebars.js b/docs/app/sidebars.js index 6dd46fb2a4d..288a68401ba 100644 --- a/docs/app/sidebars.js +++ b/docs/app/sidebars.js @@ -207,8 +207,6 @@ const sidebars = { items: require("./docs/nixhub/sidebar"), }, ], - - cloudSidebar: require("./docs/cloud/sidebar"), }; export default sidebars;