Skip to content

Commit 2d6b82e

Browse files
author
Natalie Arellano
committed
More cleanup
Signed-off-by: Natalie Arellano <[email protected]>
1 parent a7a12c0 commit 2d6b82e

File tree

11 files changed

+83
-80
lines changed

11 files changed

+83
-80
lines changed

‎content/docs/for-buildpack-authors/how-to/distribute-buildpacks/package-buildpack.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
+++
2-
title="Package a buildpack"
2+
title="Package a buildpack or extension"
33
weight=5
4-
summary="Learn how to package your buildpack for distribution using standard OCI registries."
4+
summary="Learn how to package your buildpack or extension for distribution."
55
+++
66

7-
{{< param "summary" >}}
8-
97
### 0. Grab the sample repo
108

119
Before we start, let's pull down a few buildpacks from our [samples][samples] repo.

‎content/docs/for-buildpack-authors/how-to/distribute-buildpacks/publish-buildpack/_index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
+++
22
title="Publish a buildpack"
33
weight=5
4-
summary="Learn how to publish your buildpack to the Buildpack Registry."
54
+++
65

7-
{{< param "summary" >}}
6+
Learn how to publish your buildpack to the Buildpack Registry.
7+
8+
<!--more-->
89

910
### 0. Packaging your buildpack
1011

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,8 @@
22
title="What is the lifecycle?"
33
weight=3
44
include_summaries=true
5-
65
+++
76

8-
## What is the lifecycle?
9-
10-
The `lifecycle` orchestrates buildpack execution, then assembles the resulting artifacts into an OCI image.
7+
The `lifecycle` orchestrates buildpack execution, then assembles the resulting artifacts into an [OCI image](https://github.com/opencontainers/image-spec).
118

129
<!--more-->

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
+++
22
title="Analyze"
33
weight=1
4-
summary="Restores files that buildpacks may use to optimize the build and export phases."
54
+++
65

7-
{{< param "summary" >}}
6+
The `analyzer` restores files that buildpacks may use to optimize the build and export phases.
7+
8+
<!--more-->
89

910
Prior to `Platform API 0.7`, the `analyzer` was responsible for analyzing the metadata from the cache and the previously built image (if available) to determine what layers can or cannot be reused.
1011
This information is used during the `export` phase in order to avoid re-uploading unchanged layers.\
@@ -13,12 +14,12 @@ For more information, please see [this migration guide][platform-api-06-07-migra
1314

1415
### Exit Codes
1516

16-
| Exit Code | Result|
17-
|-----------------|-------|
18-
| `0` | Success
19-
| `11` | Platform API incompatibility error
20-
| `12` | Buildpack API incompatibility error
21-
| `1-10`, `13-19` | Generic lifecycle errors
22-
| `30-39` | Analysis-specific lifecycle errors
17+
| Exit Code | Result |
18+
|-----------------|-------------------------------------|
19+
| `0` | Success |
20+
| `11` | Platform API incompatibility error |
21+
| `12` | Buildpack API incompatibility error |
22+
| `1-10`, `13-19` | Generic lifecycle errors |
23+
| `30-39` | Analysis-specific lifecycle errors |
2324

2425
[platform-api-06-07-migration]: https://buildpacks.io/docs/for-platform-operators/how-to/migrate/platform-api-0.6-0.7/

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

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
+++
22
title="Build"
33
weight=4
4-
summary="Transforms application source code into runnable artifacts that can be packaged into a container."
54
+++
65

7-
{{< param "summary" >}}
6+
The `builder` transforms application source code into runnable artifacts that can be packaged into a container.
7+
8+
<!--more-->
89

910
### Exit Codes
1011

11-
| Exit Code | Result|
12-
|-----------------|-------|
13-
| `0` | Success
14-
| `11` | Platform API incompatibility error
15-
| `12` | Buildpack API incompatibility error
16-
| `1-10`, `13-19` | Generic lifecycle errors
17-
| `51` | Buildpack build error
18-
| `50`, `52-59` | Build-specific lifecycle errors
12+
| Exit Code | Result |
13+
|-----------------|-------------------------------------|
14+
| `0` | Success |
15+
| `11` | Platform API incompatibility error |
16+
| `12` | Buildpack API incompatibility error |
17+
| `1-10`, `13-19` | Generic lifecycle errors |
18+
| `51` | Buildpack build error |
19+
| `50`, `52-59` | Build-specific lifecycle errors |

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

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
+++
22
title="Create"
33
weight=6
4-
summary="Runs analyze, detect, restore, build, and export in a single command."
54
+++
65

7-
{{< param "summary" >}}
6+
The `creator` runs analyze, detect, restore, build, and export in a single command.
7+
8+
<!--more-->
89

910
### Exit Codes
1011

11-
| Exit Code | Result|
12-
|-----------------|-------|
13-
| `0` | Success
14-
| `11` | Platform API incompatibility error
15-
| `12` | Buildpack API incompatibility error
16-
| `1-10`, `13-19` | Generic lifecycle errors
17-
| `20-29` | Detection-specific lifecycle errors
18-
| `30-39` | Analysis-specific lifecycle errors
19-
| `40-49` | Restoration-specific lifecycle errors
20-
| `50-59` | Build-specific lifecycle errors
21-
| `60-69` | Export-specific lifecycle errors
12+
| Exit Code | Result |
13+
|-----------------|---------------------------------------|
14+
| `0` | Success |
15+
| `11` | Platform API incompatibility error |
16+
| `12` | Buildpack API incompatibility error |
17+
| `1-10`, `13-19` | Generic lifecycle errors |
18+
| `20-29` | Detection-specific lifecycle errors |
19+
| `30-39` | Analysis-specific lifecycle errors |
20+
| `40-49` | Restoration-specific lifecycle errors |
21+
| `50-59` | Build-specific lifecycle errors |
22+
| `60-69` | Export-specific lifecycle errors |

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
+++
22
title="Detect"
33
weight=2
4-
summary="Finds an ordered group of buildpacks to use during the build phase."
54
+++
65

7-
{{< param "summary" >}}\
8-
\
6+
The `detector` finds an ordered group of buildpacks to use during the build phase.
7+
8+
<!--more-->
9+
910
Detection is the first phase of the Lifecycle. It’s done by the `detector`.
1011
In this phase, the detector looks for an ordered group of buildpacks that will be used during the build phase.
1112
The detector is invoked in the build environment without any required arguments and it cannot run with root privileges.

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
+++
22
title="Export"
33
weight=5
4-
summary="Creates the final OCI image."
54
+++
65

7-
{{< param "summary" >}}
6+
The `exporter` creates the final OCI image.
87

9-
### Exit Codes
8+
<!--more-->
109

11-
| Exit Code | Result|
12-
|-----------------|-------|
13-
| `0` | Success
14-
| `11` | Platform API incompatibility error
15-
| `12` | Buildpack API incompatibility error
16-
| `1-10`, `13-19` | Generic lifecycle errors
17-
| `60-69` | Export-specific lifecycle errors
10+
### Exit Codes
1811

12+
| Exit Code | Result |
13+
|-----------------|-------------------------------------|
14+
| `0` | Success |
15+
| `11` | Platform API incompatibility error |
16+
| `12` | Buildpack API incompatibility error |
17+
| `1-10`, `13-19` | Generic lifecycle errors |
18+
| `60-69` | Export-specific lifecycle errors |
1919

2020
### Image
2121

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

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
+++
22
title="Launch"
33
weight=7
4-
summary="The entrypoint for the final OCI image. Responsible for launching application processes."
54
+++
65

7-
{{< param "summary" >}}
6+
The `launcher` is the entrypoint for the final OCI image, responsible for launching application processes.
7+
8+
<!--more-->
89

910
### Exit Codes
1011

11-
| Exit Code | Result|
12-
|-----------|-------|
13-
| `11` | Platform API incompatibility error
14-
| `12` | Buildpack API incompatibility error
15-
| `80-89` | Launch-specific lifecycle errors
12+
| Exit Code | Result |
13+
|-----------|-------------------------------------|
14+
| `11` | Platform API incompatibility error |
15+
| `12` | Buildpack API incompatibility error |
16+
| `80-89` | Launch-specific lifecycle errors |

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
+++
22
title="Rebase"
33
weight=8
4-
summary="Rebase application layers onto a new run image."
54
+++
65

7-
{{< param "summary" >}}
6+
The `rebaser` places application layers atop a new version of the runtime base image.
7+
8+
<!--more-->
89

910
### Exit Codes
1011

11-
| Exit Code | Result|
12-
|-----------------|-------|
13-
| `0` | Success
14-
| `11` | Platform API incompatibility error
15-
| `12` | Buildpack API incompatibility error
16-
| `1-10`, `13-19` | Generic lifecycle errors
17-
| `70-79` | Rebase-specific lifecycle errors
12+
| Exit Code | Result |
13+
|-----------------|-------------------------------------|
14+
| `0` | Success |
15+
| `11` | Platform API incompatibility error |
16+
| `12` | Buildpack API incompatibility error |
17+
| `1-10`, `13-19` | Generic lifecycle errors |
18+
| `70-79` | Rebase-specific lifecycle errors |

0 commit comments

Comments
 (0)