Skip to content

Commit

Permalink
Fix broken links
Browse files Browse the repository at this point in the history
Signed-off-by: Natalie Arellano <[email protected]>
  • Loading branch information
natalieparellano committed Feb 13, 2024
1 parent 270bfd9 commit 6c49ce5
Show file tree
Hide file tree
Showing 45 changed files with 142 additions and 85 deletions.
2 changes: 1 addition & 1 deletion content/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ If you didn't find anything you'd like to improve while going through the tutori
[talks]: /docs/#talks
[tutorials]: /docs/#tutorials
[spec]: /docs/reference/spec/
[platforms]: /docs/concepts/components/platform/
[platforms]: /docs/for-platform-operators/concepts/platform/
[pack]: https://github.com/buildpacks/pack
[lifecycle]: https://github.com/buildpacks/lifecycle
[docs]: https://github.com/buildpacks/docs
Expand Down
4 changes: 2 additions & 2 deletions content/docs/app-journey.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Windows image builds are now supported!

<a href="/docs/for-app-developers/how-to/configure-build-environment/build-for-windows" class="button bg-blue">Windows build guide</a>

[builder]: /docs/concepts/components/builder/
[buildpack]: /docs/concepts/components/buildpack/
[builder]: /docs/for-platform-operators/concepts/builder/
[buildpack]: /docs/for-platform-operators/concepts/buildpack/
[samples-java-maven]: https://github.com/buildpacks/samples/tree/main/apps/java-maven
[pack-docs]: /docs/tools/pack/
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ os = "linux"
```

The buildpack ID is the way you will reference the buildpack when you create buildpack groups, builders, etc.
[Targets](/docs/concepts/components/targets/) identifies the kind of build and run base images the buildpack will work with.
[Targets](/docs/for-platform-operators/concepts/targets/) identifies the kind of build and run base images the buildpack will work with.
The stack ID (deprecated) uniquely identifies a build and run image configuration the buildpack will work with. This example can be run on Ubuntu Jammy.

### `detect` and `build`
Expand Down Expand Up @@ -136,5 +136,5 @@ ERROR: failed to detect: buildpack(s) failed with err

<a href="/docs/buildpack-author-guide/create-buildpack/detection" class="button bg-pink">Next Step</a>

[builder]: /docs/concepts/components/builder
[builder]: /docs/for-platform-operators/concepts/builder
<!--+ end +-->
6 changes: 3 additions & 3 deletions content/docs/concepts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Buildpacks allow you to convert your source code into a secure, efficient, produ

![buildpacks](/docs/concepts/what.svg)

**[Buildpacks](/docs/concepts/components/buildpack) provide framework and runtime support for applications.** Buildpacks examine your apps to determine all the dependencies it needs and configure them appropriately to run on any cloud.
**[Buildpacks](/docs/for-platform-operators/concepts/buildpack) provide framework and runtime support for applications.** Buildpacks examine your apps to determine all the dependencies it needs and configure them appropriately to run on any cloud.


## How do they work?
Expand Down Expand Up @@ -47,10 +47,10 @@ For example:

![builder](/docs/concepts/builder.svg)

[`Builders`](/docs/concepts/components/builder) are an ordered combination of [`buildpacks`](/docs/concepts/components/buildpack) with a base `build image`, a lifecycle, and reference to a `run image`.
[`Builders`](/docs/for-platform-operators/concepts/builder) are an ordered combination of [`buildpacks`](/docs/for-platform-operators/concepts/buildpack) with a base `build image`, a lifecycle, and reference to a `run image`.
They take in your `app` source code and build the output `app image`. The `build image` provides the base environment for the `builder` (for eg. an Ubuntu Bionic OS image with build tooling) and a `run image` provides the base environment for the `app image` during runtime.

Under the hood a builder uses the [`lifecycle`](/docs/concepts/components/lifecycle) to run the `detect` phase for all the `buildpacks` it contains in order and then proceeds to run the `build` phase of all the `buildpacks` that passed detection.
Under the hood a builder uses the [`lifecycle`](/docs/for-platform-operators/concepts/lifecycle) to run the `detect` phase for all the `buildpacks` it contains in order and then proceeds to run the `build` phase of all the `buildpacks` that passed detection.

This allows us to have a **single** `builder` that can detect and build various kinds of applications automatically.

Expand Down
7 changes: 0 additions & 7 deletions content/docs/concepts/components/_index.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
+++
title="Buildpacks basics"
weight=1
expand=false
+++

Learn how buildpacks convert your application source code into a secure, efficient, production-ready container image.

<!--more-->

## What are buildpacks?

![buildpacks](/docs/concepts/what.svg)

**[Buildpacks](/docs/for-platform-operators/concepts/buildpack) provide framework and runtime support for applications.** Buildpacks examine your apps to determine all the dependencies it needs and configure them appropriately to run on any cloud.


## How do they work?

![how](/docs/concepts/how.svg)

**Each buildpack comprises of two phases -**

### Detect phase

The `detect` phase runs against your source code to determine if the buildpack is applicable or not. Once a buildpack is `detected` to be applicable, it proceeds to the `build` stage. If the project fails `detection` the `build` stage for a specific buildpack is skipped.

For example:

- A Python buildpack may look for a `requirements.txt` or a `setup.py` file pass
- A Node buildpack may look for a `package-lock.json` file to pass

### Build phase

The `build` phase runs against your source code to -

- Set up the build-time and run-time environment
- Download dependencies and compile your source code (if needed)
- Set appropriate entry point and startup scripts

For example:

- A Python buildpack may run `pip install -r requirements.txt` if it detected a `requirements.txt` file
- A Node buildpack may run `npm install` if it detected a `package-lock.json` file

## What is a builder?

![builder](/docs/concepts/builder.svg)

[`Builders`](/docs/for-platform-operators/concepts/builder) are an ordered combination of [`buildpacks`](/docs/for-platform-operators/concepts/buildpack) with a base `build image`, a lifecycle, and reference to a `run image`.
They take in your `app` source code and build the output `app image`. The `build image` provides the base environment for the `builder` (for eg. an Ubuntu Bionic OS image with build tooling) and a `run image` provides the base environment for the `app image` during runtime.

Under the hood a builder uses the [`lifecycle`](/docs/for-platform-operators/concepts/lifecycle) to run the `detect` phase for all the `buildpacks` it contains in order and then proceeds to run the `build` phase of all the `buildpacks` that passed detection.

This allows us to have a **single** `builder` that can detect and build various kinds of applications automatically.

For example, let's say `demo-builder` contains the `Python` and `Node` buildpack. Then -

- If your project just has a `requirements.txt`, `demo-builder` will only run the Python `build` steps.
- If your project just has a `package-lock.json`, `demo-builder` will only run the Node `build` steps.
- If your project has both `package-lock.json` and `requirements.txt`, `demo-builder` will run **both** the Python and Node `build` steps.
- If your project has no related files, `demo-builder` will fail to `detect` and exit.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
+++
title="Operations"
title="Buildpacks operations"
weight=2
include_summaries=true
expand=true
+++
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ summary="Build is the process of executing one or more buildpacks against the ap

## Building explained

![build diagram](/docs/concepts/operations/build.svg)
![build diagram](/docs/for-app-developers/concepts/buildpacks-operations/build.svg)

{{< param "summary" >}} Each buildpack inspects the source code and provides relevant dependencies.
An image is then generated from the app's source code and these dependencies.

During the build process, the [build image](/docs/concepts/components/base-images/build/) becomes the environment in which buildpacks are executed,
and the [run image](/docs/concepts/components/base-images/run/) becomes the base for the final app image.
During the build process, the [build image](/docs/for-platform-operators/concepts/base-images/build/) becomes the environment in which buildpacks are executed,
and the [run image](/docs/for-platform-operators/concepts/base-images/run/) becomes the base for the final app image.

Buildpacks can be bundled together with a specific build image, resulting in a [builder](/docs/concepts/components/builder) image.
Buildpacks can be bundled together with a specific build image, resulting in a [builder](/docs/for-platform-operators/concepts/builder) image.
Builders provide a convenient way to distribute buildpacks.
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ aliases=[

{{< param "summary" >}} By using image layer rebasing, this command avoids the need to fully rebuild the app.

![rebase diagram](/docs/concepts/operations/rebase.svg)
![rebase diagram](/docs/for-app-developers/concepts/buildpacks-operations/rebase.svg)

At its core, image rebasing is a simple process. By inspecting an app image, `rebase` can determine whether or not a
newer version of the app's base image exists (either locally or in a registry). If so, `rebase` updates the app image's
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title="Build reproducibility"
weight=2
weight=3
+++

Given the same inputs, two builds should produce the same outputs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,9 @@ curl http://10.0.0.1:8080
[docker-env-vars]: https://docs.docker.com/engine/reference/commandline/cli/#environment-variables
[docker-hosts]: #understanding-docker-hosts
[build-linux]: /docs/for-app-developers/tutorials/basic-app
[build]: /docs/concepts/operations/build
[builder]: /docs/concepts/components/builder
[buildpack]: /docs/concepts/components/buildpack
[build]: /docs/for-app-developers/concepts/buildpacks-operations/build
[builder]: /docs/for-platform-operators/concepts/builder
[buildpack]: /docs/for-platform-operators/concepts/buildpack
[samples]: https://github.com/buildpacks/samples
[docker-general-settings]: https://docs.docker.com/docker-for-windows/#general
[windows-openssh-server]: https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Where:
podman images
```

[builder]: https://buildpacks.io/docs/concepts/components/builder/
[builder]: https://buildpacks.io/docs/for-platform-operators/concepts/builder/

---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
+++
title="Build an application with buildpacks"
weight=1
expand=true
include_summaries=true
+++
8 changes: 4 additions & 4 deletions content/docs/for-app-developers/tutorials/basic-app/build.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
+++
title="Build an app"
title="Build the app"
weight=1
summary="The basics of taking your app from source code to runnable image."
aliases=[
Expand Down Expand Up @@ -84,7 +84,7 @@ Windows image builds are now supported!
Check out the [Windows build guide](https://buildpacks.io/docs/for-app-developers/how-to/configure-build-environment/build-for-windows/).
` +-->

[build]: /docs/concepts/operations/build
[builder]: /docs/concepts/components/builder
[buildpack]: /docs/concepts/components/buildpack
[build]: /docs/for-app-developers/concepts/buildpacks-operations/build
[builder]: /docs/for-platform-operators/concepts/builder
[buildpack]: /docs/for-platform-operators/concepts/buildpack
[samples]: https://github.com/buildpacks/samples
4 changes: 2 additions & 2 deletions content/docs/for-app-developers/tutorials/basic-app/run.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title="Specify launch process"
weight=5
title="Run the app"
weight=2
summary="Learn how to specify the launch process for an app."
+++

Expand Down
9 changes: 5 additions & 4 deletions content/docs/for-platform-operators/concepts/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
+++
title="Concepts"
weight=2
expand=false
title="Components"
weight=1
include_summaries=true
+++
summaries_max_depth=1
expand=true
+++
Original file line number Diff line number Diff line change
Expand Up @@ -11,22 +11,22 @@ aliases=[

{{< param "summary" >}}

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

## Anatomy of a builder

A builder consists of the following components:

* [Buildpacks][buildpack]
* A [lifecycle][lifecycle]
* A [build image](/docs/concepts/components/base-images/build/)
* A reference to a [run image](/docs/concepts/components/base-images/run/)
* A [build image](/docs/for-platform-operators/concepts/base-images/build/)
* A reference to a [run image](/docs/for-platform-operators/concepts/base-images/run/)

### Resources

To learn how to create your own builder, see our [Operator's Guide][operator-guide].

[builder-config]: /docs/reference/builder-config/
[operator-guide]: /docs/for-platform-operators/
[buildpack]: /docs/concepts/components/buildpack/
[lifecycle]: /docs/concepts/components/lifecycle/
[buildpack]: /docs/for-platform-operators/concepts/buildpack/
[lifecycle]: /docs/for-platform-operators/concepts/lifecycle/
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,5 @@ The [Operator's Guide][operator-guide] has more information on creating builders
[buildpack-group]: /docs/reference/config/builder-config/#order-_list-required_
[order-resolution]: https://github.com/buildpacks/spec/blob/main/buildpack.md#order-resolution
[operator-guide]: /docs/for-platform-operators/
[builder]: /docs/concepts/components/builder/
[meta-buildpack]: /docs/concepts/components/buildpack/#meta-buildpack
[builder]: /docs/for-platform-operators/concepts/builder/
[meta-buildpack]: /docs/for-platform-operators/concepts/buildpack/#meta-buildpack
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ Buildpacks can be [packaged][package-a-buildpack] as OCI images on an image regi
Learn more about buildpacks by referring to the [Buildpack API][buildpack-api].

[buildpack-api]: /docs/reference/buildpack-api
[buildpack-group]: /docs/concepts/components/buildpack-group/
[buildpack-group]: /docs/for-platform-operators/concepts/buildpack-group/
[package-a-buildpack]: /docs/for-buildpack-authors/how-to/distribute-buildpacks/package-buildpack/
[platform]: /docs/concepts/components/platform
[platform]: /docs/for-platform-operators/concepts/platform
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ The platform [specification][spec] details what a platform does, and how it inte

For the latest version of the Platform API, see [releases][releases] on the spec repo.

[builder]: /docs/concepts/components/builder/
[buildpack]: /docs/concepts/components/buildpack/
[lifecycle]: /docs/concepts/components/lifecycle/
[builder]: /docs/for-platform-operators/concepts/builder/
[buildpack]: /docs/for-platform-operators/concepts/buildpack/
[lifecycle]: /docs/for-platform-operators/concepts/lifecycle/
[spec]: https://github.com/buildpacks/spec/blob/main/platform.md
[pack]: https://github.com/buildpacks/pack
[buildpacks-tekton]: https://github.com/tektoncd/catalog/tree/master/task/buildpacks
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ As of Platform API 0.12 and Buildpack API 0.10, stacks are deprecated in favor o
For more information, see
* Platform API 0.12 [migration guide](/docs/for-platform-operators/how-to/migrate/platform-api-0.11-0.12/)
* Buildpack API 0.10 [migration guide](/docs/for-buildpack-authors/how-to/migrate/buildpack-api-0.9-0.10/)
* [Build image](/docs/concepts/components/base-images/build/) concept
* [Run image](/docs/concepts/components/base-images/run/) concept
* [Target data](/docs/concepts/components/targets/)
* [Build image](/docs/for-platform-operators/concepts/base-images/build/) concept
* [Run image](/docs/for-platform-operators/concepts/base-images/run/) concept
* [Target data](/docs/for-platform-operators/concepts/targets/)

For older API versions, see below on using stacks.

Expand Down Expand Up @@ -53,6 +53,6 @@ By providing the required `[stack]` section, a builder author can configure a st
To learn how to create your own stack, see our [Operator's Guide][operator-guide].

[operator-guide]: /docs/for-platform-operators/
[builder]: /docs/concepts/components/builder/
[buildpack]: /docs/concepts/components/buildpack/
[lifecycle]: /docs/concepts/components/lifecycle/
[builder]: /docs/for-platform-operators/concepts/builder/
[buildpack]: /docs/for-platform-operators/concepts/buildpack/
[lifecycle]: /docs/for-platform-operators/concepts/lifecycle/
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -142,5 +142,5 @@ type = "image"
url = "https://github.com/example/repo"
```

[lifecycle]: /docs/concepts/components/lifecycle/
[lifecycle]: /docs/for-platform-operators/concepts/lifecycle/
[project-metadata]: https://github.com/buildpacks/spec/blob/platform/0.7/platform.md#project-metadatatoml-toml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ go get -u github.com/buildpacks/pack
- [Docs](https://pkg.go.dev/github.com/buildpacks/pack)
- [Source](https://github.com/buildpacks/pack/)

[build]: /docs/concepts/operations/build/
[rebase]: /docs/concepts/operations/rebase/
[components]: /docs/concepts/components/
[build]: /docs/for-app-developers/concepts/buildpacks-operations/build/
[rebase]: /docs/for-app-developers/concepts/buildpacks-operations/rebase/
[components]: /docs/for-platform-operators/concepts/
[github-releases]: https://github.com/buildpacks/pack/releases
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,7 @@ Some general resources for Tekton are:
- [Tekton Authorization Documentation][tekton-auth]

[tekton]: https://tekton.dev/
[lifecycle]: /docs/concepts/components/lifecycle
[lifecycle]: /docs/for-platform-operators/concepts/lifecycle
[buildpacks-task]: https://github.com/tektoncd/catalog/tree/master/task/buildpacks
[buildpacks-phases]: https://github.com/tektoncd/catalog/tree/master/task/buildpacks-phases
[tekton-setup]: https://tekton.dev/docs/getting-started/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ Lifecycle exit codes are condensed to be within 0-255 so that they are understan

The report.toml output by the exporter will now include the image manifest size in bytes. Note that this only applies to published images, as images exported to a docker daemon will not have a manifest.

[lifecycle]: /docs/concepts/components/lifecycle/
[lifecycle]: /docs/for-platform-operators/concepts/lifecycle/
Original file line number Diff line number Diff line change
Expand Up @@ -94,14 +94,14 @@ following the [rules](https://github.com/buildpacks/spec/blob/platform/v0.12/pla

The feature is enabled by providing a `-layout` flag or by setting the `CNB_USE_LAYOUT` environment variable to `true` for the following lifecycle phases:

- [Analyze](https://buildpacks.io/docs/concepts/components/lifecycle/analyze/)
- [Restore](https://buildpacks.io/docs/concepts/components/lifecycle/restore/)
- [Export](https://buildpacks.io/docs/concepts/components/lifecycle/export/)
- [Create](https://buildpacks.io/docs/concepts/components/lifecycle/create/)
- [Analyze](https://buildpacks.io/docs/for-platform-operators/concepts/lifecycle/analyze/)
- [Restore](https://buildpacks.io/docs/for-platform-operators/concepts/lifecycle/restore/)
- [Export](https://buildpacks.io/docs/for-platform-operators/concepts/lifecycle/export/)
- [Create](https://buildpacks.io/docs/for-platform-operators/concepts/lifecycle/create/)

Additionally, the path to the layout directory must be specified, either by providing a `-layout-dir` flag or by setting the `CNB_LAYOUT_DIR` environment variable.

**Note**: [Rebasing](https://buildpacks.io/docs/concepts/components/lifecycle/rebase/) an image exported to OCI layout format
**Note**: [Rebasing](https://buildpacks.io/docs/for-platform-operators/concepts/lifecycle/rebase/) an image exported to OCI layout format
and extending OCI layout base images with Dockerfiles are currently not supported.

## Base Image Author
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ The given user **MUST NOT** be a root user, and must have a writeable home direc

Finally, we need to label the image with operating system distribution information for platforms and the lifecycle to use.

To determine which values to provide, see [targets](/docs/concepts/components/targets/) concept information.
To determine which values to provide, see [targets](/docs/for-platform-operators/concepts/targets/) concept information.

## Build the build base image

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ For additional sample builders and buildpacks, check out our [samples][samples]

You can also check out our reference of the builder config [here][builder-config].

[build]: /docs/concepts/operations/build/
[builder]: /docs/concepts/components/builder/
[build]: /docs/for-app-developers/concepts/buildpacks-operations/build/
[builder]: /docs/for-platform-operators/concepts/builder/
[builder-config]: /docs/reference/builder-config/
[samples]: https://github.com/buildpacks/samples
Loading

0 comments on commit 6c49ce5

Please sign in to comment.