Skip to content

Commit a1e2e6c

Browse files
author
Natalie Arellano
committed
Clean up platform-operator section
Signed-off-by: Natalie Arellano <[email protected]>
1 parent b302ea2 commit a1e2e6c

File tree

20 files changed

+72
-37
lines changed

20 files changed

+72
-37
lines changed

‎content/docs/for-app-developers/concepts/base-images/build.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,8 @@ The **build image** provides the base image from which the build environment is
77

88
<!--more-->
99

10-
The build environment is the containerized environment in which the [lifecycle][lifecycle] (and thereby [buildpacks][buildpack]) are executed.
10+
The build environment is the containerized environment in which the [lifecycle]
11+
(and thereby [buildpacks][buildpack]) are executed.
12+
13+
[lifecycle]: /docs/for-platform-operators/concepts/lifecycle/
14+
[buildpack]: /docs/for-app-developers/concepts/buildpack/

‎content/docs/for-platform-operators/concepts/builder.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
+++
2-
title="Builder"
3-
weight=1
4-
summary="A builder is an image that contains all the components necessary to execute a build. A builder image is created by taking a build image and adding a lifecycle, buildpacks, and files that configure aspects of the build including the buildpack detection order and the location(s) of the run image"
2+
title="What is a builder?"
3+
weight=2
54
aliases=[
65
"/docs/using-pack/working-with-builders/"
76
]
87
+++
98

10-
## What is a builder?
9+
A `builder` is an OCI image containing
10+
an ordered combination of [buildpacks][buildpack] and
11+
a build-time base image, a [lifecycle] binary, and a reference to a runtime base image.
1112

12-
{{< param "summary" >}}
13+
<!--more-->
1314

1415
![create-builder diagram](/docs/for-platform-operators/concepts/create-builder.svg)
1516

@@ -27,6 +28,6 @@ A builder consists of the following components:
2728
To learn how to create your own builder, see our [Operator's Guide][operator-guide].
2829

2930
[builder-config]: /docs/reference/builder-config/
30-
[operator-guide]: /docs/for-platform-operators/
3131
[buildpack]: /docs/for-platform-operators/concepts/buildpack/
3232
[lifecycle]: /docs/for-platform-operators/concepts/lifecycle/
33+
[operator-guide]: /docs/for-platform-operators/

‎content/docs/for-platform-operators/concepts/buildpack.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
+++
2-
title="Buildpack"
3-
weight=2
2+
title="What is a buildpack?"
3+
weight=1
44
+++
55

6-
## What is a buildpack?
7-
8-
A buildpack is a set of executables that inspects your app source code and creates a plan to build and run your application.
6+
A `buildpack` is software that examines your source code and determines the best way to build it.
97

108
<!--more-->
119

‎content/docs/for-platform-operators/concepts/dockerfiles.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
+++
2-
title="Dockerfiles"
2+
title="What are image extensions?"
3+
weight=99
34
+++
45

5-
Dockerfiles can be used to extend base images for buildpacks builds.
6+
Image extensions generate Dockerfiles that can be used to extend base images for buildpacks builds.
67

78
<!--more-->
89

‎content/docs/for-platform-operators/concepts/lifecycle/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
+++
2-
title="Lifecycle"
2+
title="What is the lifecycle?"
33
weight=3
44
include_summaries=true
55

66
+++
77

88
## What is the lifecycle?
99

10-
The lifecycle orchestrates buildpack execution, then assembles the resulting artifacts into a final app image.
10+
The `lifecycle` orchestrates buildpack execution, then assembles the resulting artifacts into an OCI image.
1111

1212
<!--more-->

‎content/docs/for-platform-operators/how-to/prepare-build-inputs/_index.md renamed to ‎content/docs/for-platform-operators/how-to/build-inputs/_index.md

File renamed without changes.

‎content/docs/for-platform-operators/how-to/build-inputs/create-builder/_index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
+++
2+
title="Create a builder"
3+
weight=1
4+
include_summaries=true
5+
+++
6+
7+
A [builder][builder] is an OCI image with all the inputs needed for a buildpacks build, including
8+
the build-time base image, a reference to a runtime base image, a lifecycle, and a set of buildpacks.
9+
10+
[builder]: /docs/for-platform-operators/concepts/builder

‎content/docs/for-platform-operators/how-to/prepare-build-inputs/build-base.md renamed to ‎content/docs/for-platform-operators/how-to/build-inputs/create-builder/build-base.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
+++
22
title="Create a build base image"
3-
weight=2
3+
weight=1
44
+++
55

6+
The build-time base image provides the OS-level dependencies for buildpacks at build-time.
7+
68
<!--more-->
79

810
## Define a build base image for your CNB build

‎content/docs/for-platform-operators/how-to/prepare-build-inputs/builder.md renamed to ‎content/docs/for-platform-operators/how-to/build-inputs/create-builder/builder.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
+++
2-
title="Create a builder"
3-
weight=1
2+
title="Putting it all together"
3+
weight=3
44
+++
55

6-
A [builder][builder] is an OCI image with all the inputs needed for a buildpacks build, including
7-
the build-time base image, a reference to a runtime base image, a lifecycle, and a set of buildpacks.
6+
After you have created a build-time base image and a runtime base image, you are ready to create your builder!
87

98
<!--more-->
109

‎content/docs/for-platform-operators/how-to/prepare-build-inputs/extensions.md renamed to ‎content/docs/for-platform-operators/how-to/build-inputs/create-builder/extensions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title="Specify an image extension in a builder"
33
weight=101
44
+++
55

6+
If you are using extensions, here is how to include them in a builder.
7+
68
<!--more-->
79

810
You're pretty sharp, and you know what your buildpack users will need.

0 commit comments

Comments
 (0)