Skip to content

Commit fb65f9c

Browse files
committed
build: restructure manuals section
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
1 parent 79ff211 commit fb65f9c

File tree

94 files changed

+460
-488
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+460
-488
lines changed

content/build-cloud/ci.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ See [Loading build results](./usage/#loading-build-results) for details.
3838
>
3939
> Version 4.0.0 and later of `docker/build-push-action` and
4040
> `docker/bake-action` builds images with [provenance attestations by
41-
> default](/build/ci/github-actions/attestations.md#default-provenance). Docker
41+
> default](/build/github-actions/attestations.md#default-provenance). Docker
4242
> Build Cloud automatically attempts to load images to the local image store if
4343
> you don't explicitly push them to a registry.
4444
>

content/build-cloud/optimization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ For more information on how to optimize your builds, see
3535

3636
### Dockerignore files
3737

38-
Using a [`.dockerignore` file](/build/building/context/#dockerignore-files),
38+
Using a [`.dockerignore` file](/build/concepts/context.md#dockerignore-files),
3939
you can be explicit about which local files you don’t want to include in the
4040
build context. Files caught by the glob patterns you specify in your
4141
ignore-file aren't transferred to the remote builder.

content/build/_index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,37 +7,37 @@ grid:
77
description: 'Build and package your application to run it anywhere: locally or
88
in the cloud.'
99
icon: inventory_2
10-
link: /build/building/packaging
10+
link: /build/concepts/overview/
1111
- title: Multi-stage builds
1212
description: Keep your images small and secure with minimal dependencies.
1313
icon: stairs
14-
link: /build/building/multi-stage
14+
link: /build/building/multi-stage/
1515
- title: Multi-platform images
1616
description: Build, push, pull, and run images seamlessly on different computer
1717
architectures.
1818
icon: content_copy
1919
link: /build/building/multi-platform/
20-
- title: Architecture
20+
- title: BuildKit
2121
description: Explore BuildKit, the open source build engine.
2222
icon: construction
2323
link: /build/buildkit/
2424
- title: Build drivers
2525
description: Configure where and how you run your builds.
2626
icon: engineering
27-
link: /build/drivers/
27+
link: /build/builders/drivers/
2828
- title: Exporters
2929
description: Export any artifact you like, not just Docker images.
3030
icon: output
31-
link: /build/exporters
31+
link: /build/exporters/
3232
- title: Build caching
3333
description: Avoid unnecessary repetitions of costly operations, such as package
3434
installs.
3535
icon: cycle
36-
link: /build/cache
36+
link: /build/cache/
3737
- title: Bake
3838
description: Orchestrate your builds with Bake.
3939
icon: cake
40-
link: /build/bake
40+
link: /build/bake/
4141
aliases:
4242
- /buildx/working-with-buildx/
4343
- /develop/develop-images/build_enhancements/

content/build/architecture.md

Lines changed: 0 additions & 93 deletions
This file was deleted.

content/build/builders/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Docker context, your `default` builder refers to the new Docker context.
2323

2424
## Build drivers
2525

26-
Buildx implements a concept of [build drivers](../drivers/index.md) to refer to
26+
Buildx implements a concept of [build drivers](drivers/_index.md) to refer to
2727
different builder configurations. The default builder created by the daemon
28-
uses the [`docker` driver](../drivers/docker.md).
28+
uses the [`docker` driver](drivers/docker.md).
2929

3030
Buildx supports the following build drivers:
3131

@@ -69,4 +69,4 @@ selected when you invoke builds.
6969
- For information about how to interact with and manage builders,
7070
see [Manage builders](./manage.md)
7171
- To learn about different types of builders,
72-
see [Build drivers](../drivers/index.md)
72+
see [Build drivers](drivers/index.md)

content/build/drivers/_index.md renamed to content/build/builders/drivers/_index.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ aliases:
66
- /build/buildx/drivers/
77
- /build/building/drivers/
88
- /build/buildx/multiple-builders/
9+
- /build/drivers/
910
---
1011

1112
Build drivers are configurations for how and where the BuildKit backend runs.
@@ -33,7 +34,7 @@ The following table outlines some differences between drivers.
3334
| **BuildKit configuration** | ||| Managed externally |
3435

3536
\* _The `docker` driver doesn't support all cache export options.
36-
See [Cache storage backends](../cache/backends/_index.md) for more information._
37+
See [Cache storage backends](/build/cache/backends/_index.md) for more information._
3738

3839
## Loading to local image store
3940

@@ -42,26 +43,26 @@ aren't automatically loaded into the local image store. If you don't specify an
4243
output, the build result is exported to the build cache only.
4344

4445
To build an image using a non-default driver and load it to the image store,
45-
use the `--load` flag with the build command:
46-
47-
```console
48-
$ docker buildx build --load -t <image> --builder=container .
49-
...
50-
=> exporting to oci image format 7.7s
51-
=> => exporting layers 4.9s
52-
=> => exporting manifest sha256:4e4ca161fa338be2c303445411900ebbc5fc086153a0b846ac12996960b479d3 0.0s
53-
=> => exporting config sha256:adf3eec768a14b6e183a1010cb96d91155a82fd722a1091440c88f3747f1f53f 0.0s
54-
=> => sending tarball 2.8s
55-
=> importing to docker
56-
```
57-
58-
With this option, the image is available in the image store after the build finishes:
59-
60-
```console
61-
$ docker image ls
62-
REPOSITORY TAG IMAGE ID CREATED SIZE
63-
<image> latest adf3eec768a1 2 minutes ago 197MB
64-
```
46+
use the `--load` flag with the build command:
47+
48+
```console
49+
$ docker buildx build --load -t <image> --builder=container .
50+
...
51+
=> exporting to oci image format 7.7s
52+
=> => exporting layers 4.9s
53+
=> => exporting manifest sha256:4e4ca161fa338be2c303445411900ebbc5fc086153a0b846ac12996960b479d3 0.0s
54+
=> => exporting config sha256:adf3eec768a14b6e183a1010cb96d91155a82fd722a1091440c88f3747f1f53f 0.0s
55+
=> => sending tarball 2.8s
56+
=> importing to docker
57+
```
58+
59+
With this option, the image is available in the image store after the build finishes:
60+
61+
```console
62+
$ docker image ls
63+
REPOSITORY TAG IMAGE ID CREATED SIZE
64+
<image> latest adf3eec768a1 2 minutes ago 197MB
65+
```
6566

6667
### Load by default
6768

@@ -84,7 +85,7 @@ flag.
8485

8586
Read about each driver:
8687

87-
- [Docker driver](./docker.md)
88-
- [Docker container driver](./docker-container.md)
89-
- [Kubernetes driver](./kubernetes.md)
88+
- [Docker driver](./docker.md)
89+
- [Docker container driver](./docker-container.md)
90+
- [Kubernetes driver](./kubernetes.md)
9091
- [Remote driver](./remote.md)

content/build/drivers/docker-container.md renamed to content/build/builders/drivers/docker-container.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ keywords: build, buildx, driver, builder, docker-container
55
aliases:
66
- /build/buildx/drivers/docker-container/
77
- /build/building/drivers/docker-container/
8+
- /build/drivers/docker-container/
89
---
910

1011
The Docker container driver allows creation of a managed and customizable
@@ -15,7 +16,7 @@ Docker driver. For example:
1516

1617
- Specify custom BuildKit versions to use.
1718
- Build multi-arch images, see [QEMU](#qemu)
18-
- Advanced options for [cache import and export](../cache/backends/index.md)
19+
- Advanced options for [cache import and export](/build/cache/backends/_index.md)
1920

2021
## Synopsis
2122

@@ -132,14 +133,14 @@ $ docker buildx build \
132133
You can customize the network that the builder container uses. This is useful
133134
if you need to use a specific network for your builds.
134135

135-
For example, let's [create a network](../../reference/cli/docker/network/create.md)
136+
For example, let's [create a network](/reference/cli/docker/network/create.md)
136137
named `foonet`:
137138

138139
```console
139140
$ docker network create foonet
140141
```
141142

142-
Now create a [`docker-container` builder](../../reference/cli/docker/buildx/create.md)
143+
Now create a [`docker-container` builder](/reference/cli/docker/buildx/create.md)
143144
that will use this network:
144145

145146
```console
@@ -149,13 +150,13 @@ $ docker buildx create --use \
149150
--driver-opt "network=foonet"
150151
```
151152

152-
Boot and [inspect `mybuilder`](../../reference/cli/docker/buildx/inspect.md):
153+
Boot and [inspect `mybuilder`](/reference/cli/docker/buildx/inspect.md):
153154

154155
```console
155156
$ docker buildx inspect --bootstrap
156157
```
157158

158-
[Inspect the builder container](../../reference/cli/docker/inspect.md)
159+
[Inspect the builder container](/reference/cli/docker/inspect.md)
159160
and see what network is being used:
160161

161162
```console
@@ -166,4 +167,4 @@ map[foonet:0xc00018c0c0]
166167
## Further reading
167168

168169
For more information on the Docker container driver, see the
169-
[buildx reference](../../reference/cli/docker/buildx/create.md#driver).
170+
[buildx reference](/reference/cli/docker/buildx/create.md#driver).

content/build/drivers/docker.md renamed to content/build/builders/drivers/docker.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ keywords: build, buildx, driver, builder, docker
77
aliases:
88
- /build/buildx/drivers/docker/
99
- /build/building/drivers/docker/
10+
- /build/drivers/docker/
1011
---
1112

1213
The Buildx Docker driver is the default driver. It uses the BuildKit server
13-
components built directly into the Docker engine. The Docker driver requires no
14+
components built directly into the Docker Engine. The Docker driver requires no
1415
configuration.
1516

1617
Unlike the other drivers, builders using the Docker driver can't be manually
@@ -28,12 +29,12 @@ docker buildx build .
2829

2930
It's not possible to configure which BuildKit version to use, or to pass any
3031
additional BuildKit parameters to a builder using the Docker driver. The
31-
BuildKit version and parameters are preset by the Docker engine internally.
32+
BuildKit version and parameters are preset by the Docker Engine internally.
3233

3334
If you need additional configuration and flexibility, consider using the
3435
[Docker container driver](./docker-container.md).
3536

3637
## Further reading
3738

3839
For more information on the Docker driver, see the
39-
[buildx reference](../../reference/cli/docker/buildx/create.md#driver).
40+
[buildx reference](/reference/cli/docker/buildx/create.md#driver).

content/build/drivers/kubernetes.md renamed to content/build/builders/drivers/kubernetes.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ keywords: build, buildx, driver, builder, kubernetes
77
aliases:
88
- /build/buildx/drivers/kubernetes/
99
- /build/building/drivers/kubernetes/
10+
- /build/drivers/kubernetes/
1011
---
1112

1213
The Kubernetes driver lets you connect your local development or CI
@@ -108,7 +109,7 @@ replicas. `sticky` (the default) attempts to connect the same build performed
108109
multiple times to the same node each time, ensuring better use of local cache.
109110

110111
For more information on scalability, see the options for
111-
[`docker buildx create`](../../reference/cli/docker/buildx/create.md#driver-opt).
112+
[`docker buildx create`](/reference/cli/docker/buildx/create.md#driver-opt).
112113

113114
## Node assignment
114115

@@ -143,7 +144,7 @@ $ docker buildx create \
143144
## Multi-platform builds
144145

145146
The Kubernetes driver has support for creating
146-
[multi-platform images](../building/multi-platform.md),
147+
[multi-platform images](/build/building/multi-platform.md),
147148
either using QEMU or by leveraging the native architecture of nodes.
148149

149150
### QEMU
@@ -344,9 +345,9 @@ Prerequisites:
344345
--push .
345346
```
346347

347-
That's it! You've now built an image from a Kubernetes pod, using Buildx!
348+
That's it: you've now built an image from a Kubernetes pod, using Buildx.
348349

349350
## Further reading
350351

351352
For more information on the Kubernetes driver, see the
352-
[buildx reference](../../reference/cli/docker/buildx/create.md#driver).
353+
[buildx reference](/reference/cli/docker/buildx/create.md#driver).

content/build/drivers/remote.md renamed to content/build/builders/drivers/remote.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ keywords: build, buildx, driver, builder, remote
77
aliases:
88
- /build/buildx/drivers/remote/
99
- /build/building/drivers/remote/
10+
- /build/drivers/remote/
1011
---
1112

1213
The Buildx remote driver allows for more complex custom build workloads,

0 commit comments

Comments
 (0)