From ee7b509177e790c64db701e9a8ff276f2bd3fb5e Mon Sep 17 00:00:00 2001 From: Kristen Foster-Marks Date: Thu, 24 Oct 2024 08:35:52 -0600 Subject: [PATCH 1/6] docs: make 'key features' declaration more concise --- content/overview/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/overview/index.mdx b/content/overview/index.mdx index b1d8109..1522b4e 100644 --- a/content/overview/index.mdx +++ b/content/overview/index.mdx @@ -16,7 +16,7 @@ Depot is a build acceleration platform focused on making builds radically more e Depot makes your builds faster with as little additional configuration as possible. The overarching philosophy is to meet you where you're already building and give you tools & compute tailored to making your builds as fast as possible. -We have a few key features that compose Depot that are worth knowing about: +There are a few key Depot features worth knowing about: ### Build isolation & acceleration From 4ed3ef799173a54cd6c3ce13e189647634b85023 Mon Sep 17 00:00:00 2001 From: Kristen Foster-Marks Date: Thu, 24 Oct 2024 08:38:20 -0600 Subject: [PATCH 2/6] docs: make header casing consistent --- content/overview/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/overview/index.mdx b/content/overview/index.mdx index 1522b4e..c2b6c29 100644 --- a/content/overview/index.mdx +++ b/content/overview/index.mdx @@ -48,7 +48,7 @@ Using Depot for your Docker image builds is as straightforward as replacing your To use our GitHub Actions Runners, you can add a label to your GitHub Actions job to run it on our runners. We support all the same features as GitHub-hosted runners, but with better performance like 1 GB/s networks, 10x faster caching, and 30% faster compute. -### CI & Dev tool integrations +### CI & dev tool integrations We have extensive integrations with most major CI providers and developer tools to make it easy to use Depot in your existing workflows. To see how to get faster Docker image builds with Depot in your CI provider, check out our [CI provider docs.](/docs/guides/continuous-integration) @@ -62,7 +62,7 @@ For more information on how to use Depot with developer tools like Docker, Dev C For our [remote container builds service](/docs/container-builds/overview), we support OIDC trust relationships with GitHub, CircleCI, Buildkite, and Mint so that you don't need any static access tokens in your CI provider to leverage Depot. You can learn more about configuring a trust relationship in our [authentication docs.](/docs/cli/authentication) -### Ephemeral Registry +### Ephemeral registry Our remote container builds service comes with a built-in ephemeral registry that you can use to save the images from your `depot build` and `depot bake` commands to a temporary registry. You can then pull those images back down or push them onto your final registry as you see fit. You can read more in our [ephemeral registry guide.](/docs/guides/ephemeral-registry) From dcad6bcbb262abcd594fe1af814baec03572cfd5 Mon Sep 17 00:00:00 2001 From: Kristen Foster-Marks Date: Thu, 24 Oct 2024 08:40:35 -0600 Subject: [PATCH 3/6] docs: fix comma splice --- content/container-builds/quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/container-builds/quickstart.mdx b/content/container-builds/quickstart.mdx index 2003280..9716cd0 100644 --- a/content/container-builds/quickstart.mdx +++ b/content/container-builds/quickstart.mdx @@ -6,7 +6,7 @@ description: Get started with Depot for up to 40x faster container image builds Below is a guide to leveraging Depot for up to 40x faster container image builds with a literal drop-in replacement for `docker build`. -We also offer managed GitHub Actions Runners with 10x faster caching, you can get started with our runners in our [GitHub Actions Overview docs](/docs/github-actions/overview). +We also offer managed GitHub Actions Runners with 10x faster caching. You can get started with our runners in our [GitHub Actions Overview docs](/docs/github-actions/overview). ## Installing the CLI From 1472a1bcf0d12b0ab8ce735909ed9544e44b7955 Mon Sep 17 00:00:00 2001 From: Kristen Foster-Marks Date: Thu, 24 Oct 2024 08:53:58 -0600 Subject: [PATCH 4/6] docs: add subheading and make subheadings consistent --- content/container-builds/quickstart.mdx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/content/container-builds/quickstart.mdx b/content/container-builds/quickstart.mdx index 9716cd0..2488fa7 100644 --- a/content/container-builds/quickstart.mdx +++ b/content/container-builds/quickstart.mdx @@ -41,7 +41,11 @@ Every organization comes pre-configured with a `default` project that you can us ## Running a local build -There are two options for running local builds with Depot. You can use our `depot build` command which is a drop-in replacement for your existing `docker build` command. +There are two options for running local builds with Depot. + +#### Using Depot with our `depot build` command + +Our `depot build` command is a drop-in replacement for your existing `docker build` command. Once you've initialized your project, you can run `depot build` to build your Docker image. The [`build` command](/docs/cli/reference#depot-build) takes all of the same parameters as your normal `docker build` command. @@ -53,7 +57,7 @@ Your first `depot build` locally will ask you to authenticate with Depot and cho **Note: You can also specify a `DEPOT_PROJECT_ID` environment variable instead of saving a `depot.json` file.** -#### Using Depot with your existing `docker build` +#### Using Depot with your existing `docker build` command There is the option to configure your existing `docker build` commmands to leverage Depot behind the scenes for the build. This is done by configuring Depot as a plugin for the Docker CLI. You can see our [`depot configure-docker` docs](/docs/cli/reference#depot-configure-docker) for more information. From 08f504a7d30c7f9d0741a257b81bed4ed6cb0107 Mon Sep 17 00:00:00 2001 From: Kristen Foster-Marks Date: Fri, 25 Oct 2024 08:44:14 -0600 Subject: [PATCH 5/6] docs: make local build instructions a little clearer around project creation --- content/container-builds/quickstart.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/container-builds/quickstart.mdx b/content/container-builds/quickstart.mdx index 2488fa7..e3a3c76 100644 --- a/content/container-builds/quickstart.mdx +++ b/content/container-builds/quickstart.mdx @@ -36,8 +36,9 @@ Organizations are the top level entity in Depot. They typically represent a sing 2. Click on the `Create Organization` button 3. Enter an organization name 4. Click `Create organization` +5. Click `New project` and specify your preferred region, cache storage policy, and connection. -Every organization comes pre-configured with a `default` project that you can use for any container image build. The default project is placed in our US East region with a cache storage policy of 50 GB per image architecture. If you'd like to change those defaults, you can go into the Project > Settings and make any changes. +If you're not quite ready to create your own project, every organization comes pre-configured with a `default` project that you can use for any container image build. The default project is placed in our US East region with a cache storage policy of 50 GB per image architecture. If you'd like to change those defaults, you can go into the Project > Settings and make any changes. ## Running a local build @@ -47,7 +48,7 @@ There are two options for running local builds with Depot. Our `depot build` command is a drop-in replacement for your existing `docker build` command. -Once you've initialized your project, you can run `depot build` to build your Docker image. The [`build` command](/docs/cli/reference#depot-build) takes all of the same parameters as your normal `docker build` command. +Once you've created your project in the Depot app, you can run `depot build` to build your Docker image. The [`build` command](/docs/cli/reference#depot-build) takes all of the same parameters as your normal `docker build` command. ```shell depot build -t repo/image:tag . From f142776e8645c276100d0230fea652dd1df8eb00 Mon Sep 17 00:00:00 2001 From: Kristen Foster-Marks Date: Fri, 25 Oct 2024 08:58:45 -0600 Subject: [PATCH 6/6] docs: fix comma splice --- content/container-builds/quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/container-builds/quickstart.mdx b/content/container-builds/quickstart.mdx index e3a3c76..84dc8c3 100644 --- a/content/container-builds/quickstart.mdx +++ b/content/container-builds/quickstart.mdx @@ -64,7 +64,7 @@ There is the option to configure your existing `docker build` commmands to lever ## Running a build in CI -Integrating Depot into your CI workflow is a very similar process. Depot works with any CI provider, you can find guides for our most popular providers: +Integrating Depot into your CI workflow is a very similar process. Depot works with any CI provider. You can find guides for our most popular providers: - [AWS CodeBuild](../integrations/aws-codebuild) - [Bitbucket Pipelines](../integrations/bitbucket-pipelines)