Skip to content

Commit 504bdb6

Browse files
author
Natalie Arellano
committed
Split app developer guide into how-to
Signed-off-by: Natalie Arellano <[email protected]>
1 parent 3190e73 commit 504bdb6

19 files changed

+42
-47
lines changed

content/docs/app-developer-guide/_index.md

Lines changed: 0 additions & 15 deletions
This file was deleted.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
+++
2+
title="Configure build inputs"
3+
weight=1
4+
expand=false
5+
include_summaries=true
6+
+++

content/docs/app-developer-guide/environment-variables.md renamed to content/docs/for-app-developers/how-to/build-inputs/configure-build-time-environment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
2-
title="Environment variables"
3-
weight=3
4-
summary="Environment variables are a common way to configure various buildpacks at build-time."
2+
title="Configure build-time environment variables"
3+
weight=2
4+
summary="Customize buildpack behavior through the build-time environment."
55
+++
66
<!--+- `
77
# Environment variables

content/docs/app-developer-guide/mounting-volumes.md renamed to content/docs/for-app-developers/how-to/build-inputs/mount-volumes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
2-
title="Mounting Volumes"
3-
weight=4
4-
summary="Volumes are a mechanism for both supplying and persisting data generated by build containers."
2+
title="Mount volumes at build-time"
3+
weight=3
4+
summary="Supply and persist data from build containers with arbitrary volume mounts."
55
+++
66
<!--+if false+-->
77
{{< param "summary" >}}

content/docs/app-developer-guide/specify-buildpacks.md renamed to content/docs/for-app-developers/how-to/build-inputs/specify-buildpacks-from-cli.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
+++
2-
title="Specify buildpacks"
3-
weight=4
4-
summary="Learn how to specify exactly what buildpacks are used during the build process."
2+
title="Specify buildpacks or extensions at build time"
3+
weight=1
4+
summary="No builder author can be truly omniscient, and whoever created yours surely was no exception!"
55
+++
6+
67
<!--+- `
78
# Specify buildpacks
89
`+-->
910

1011
You may specify exactly what buildpacks are used during the build process by referencing them with a URI in any of the following formats.
1112

1213
| Type | Format |
13-
| --------------------- | -------------------------------------------- |
14+
|-----------------------|----------------------------------------------|
1415
| Relative | `<path>` |
1516
| Filesystem | `file://[<host>]/<path>` |
1617
| URL | `http[s]://<host>/<path>` |
@@ -50,7 +51,11 @@ pack build sample-java-maven-app \
5051
> - `--buildpack` multiple times, or
5152
> - a comma-separated list to `--buildpack` (without spaces)
5253
54+
Similarly, it is possible to provide extensions at build time:
5355

56+
```bash
57+
pack build [...] --extension=foo [...]`
58+
```
5459

5560
## Using a Project Descriptor
5661

content/docs/app-developer-guide/using-cache-image.md renamed to content/docs/for-app-developers/how-to/build-inputs/use-cache-image.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
2-
title="Cache Images"
3-
weight=4
4-
summary="Learn how to use cache-images to share cached layers"
2+
title="Use a cache image"
3+
weight=6
4+
summary="Share layers between builds with a cache image."
55
+++
66
<!--+- `
77
# Cache Images
@@ -10,7 +10,6 @@ summary="Learn how to use cache-images to share cached layers"
1010
Cache Images are a way to preserve build optimizing layers across different host machines.
1111
These images can improve performance when using `pack` in ephemeral environments such as CI/CD pipelines.
1212

13-
1413
## Using Cache Images (`--cache-image`)
1514

1615
The `--cache-image` parameter must be in the following format

content/docs/app-developer-guide/using-inline-buildpacks.md renamed to content/docs/for-app-developers/how-to/build-inputs/use-inline-buildpacks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
2-
title="Using Inline Buildpacks"
3-
weight=7
4-
summary="Learn how to create an ephemeral buildpack to customize your build."
2+
title="Use an inline buildpack"
3+
weight=5
4+
summary="Customize your build with a bit of shell script."
55
+++
66

77
You can supplement your app's build process with custom scripts by creating an _inline buildpack_. An inline buildpack is an ephemeral buildpack that's defined in your [project descriptor][project-toml] (i.e. `project.toml`). You can include a script to run as part of the build without setting up all the files and directories that are required for a complete buildpack.

content/docs/app-developer-guide/using-project-descriptor.md renamed to content/docs/for-app-developers/how-to/build-inputs/use-project-toml.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
2-
title="Using project.toml"
3-
weight=6
4-
summary="Learn how to use a project.toml file to simplify configuring pack."
2+
title="Use project.toml"
3+
weight=4
4+
summary="Simplify your `pack` configuration."
55
+++
66

77
A `project descriptor` (alternatively referred to as a `project.toml` file) allows users to detail configuration for a
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
+++
2+
title="Understand build outputs"
3+
weight=2
4+
expand=false
5+
include_summaries=true
6+
+++
File renamed without changes.

0 commit comments

Comments
 (0)