Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename extension-author-guide to extension-guide #587

Merged
merged 4 commits into from
Jun 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions content/docs/extension-author-guide/_index.md

This file was deleted.

10 changes: 10 additions & 0 deletions content/docs/extension-guide/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
+++
title="Extension Guide"
weight=4
include_summaries=true
expand=true
aliases=[
"/docs/create-extension/",
"/docs/create-author-extension/"
]
+++
32 changes: 32 additions & 0 deletions content/docs/extension-guide/consume-extension/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
+++
title="Consume an extension"
weight=4
summary="A few notes to help you consume extensions"
aliases = [
"/docs/extension-author-guide/create-extension"
]
+++

<!--+if false+-->
## Prerequisites

Before we get started, make sure you've got the following installed:

{{< download-button href="https://store.docker.com/search?type=edition&offering=community" color="blue" >}} Install Docker {{</>}}
{{< download-button href="/docs/install-pack" color="pink" >}} Install pack {{</>}}

You may also need to [create an extension](/docs/extension-guide/create-extension) so that you can consume it.

## Overview
<!--+end+-->

This is a few notes for using CNB image extensions.

- [consume in your builder](/docs/extension-guide/consume-extension/in-builder)
- [consume via pack build](/docs/extension-guide/consume-extension/from-cli)

<!--+if false+-->
---

<a href="/docs/extension-guide/consume-extension/in-builder" class="button bg-pink">Start Tutorial</a>
<!--+end+-->
14 changes: 14 additions & 0 deletions content/docs/extension-guide/consume-extension/from-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
+++
title="Specifying an Image Extension at Build Time"
weight=405
+++

<!-- test:suite=dockerfiles;weight=5 -->

### Specifying an Image Extension at Build Time

No builder can be truly omniscient, and whoever did yours surely was no exception! You need to add a little extra spice to the mix with this late-breaking extension, by doing something like:

`pack build [...] --extension=foo [...]`


25 changes: 25 additions & 0 deletions content/docs/extension-guide/consume-extension/in-builder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
+++
title="Specifying an Image Extension in the Builder"
weight=405
+++

<!-- test:suite=dockerfiles;weight=5 -->

### Specifying an Image Extension in the Builder

You're pretty sharp, and you know what your buildpack users will need.
That's why you're going to add something similar to the following lines directly to `builder.toml`:

```
[[order-extensions]]
[[order-extensions.group]]
id = "foo"
version = "0.0.1"

[[extensions]]
id = "foo"
version = "0.0.1"
uri = "/local/path/to/extension/foo" # can be relative or absolute
```


Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
title="Create an extension"
weight=4
summary="This is a step-by-step tutorial for creating and using CNB image extensions"
aliases = [
"/docs/extension-author-guide/create-extension"
]
+++

<!--+if false+-->
Expand All @@ -17,14 +20,14 @@ Before we get started, make sure you've got the following installed:

This is a step-by-step tutorial for creating and using CNB image extensions.

- [Set up your local environment](/docs/extension-author-guide/create-extension/setup-local-environment)
- [See a build that requires base image extension in order to succeed](/docs/extension-author-guide/create-extension/why-dockerfiles)
- [Building blocks of an extension](/docs/extension-author-guide/create-extension/building-blocks-extension)
- [Generating a build.Dockerfile for your application](/docs/extension-author-guide/create-extension/build-dockerfile)
- [Generating a run.Dockerfile for your application](/docs/extension-author-guide/create-extension/run-dockerfile)
- [Set up your local environment](/docs/extension-guide/create-extension/setup-local-environment)
- [See a build that requires base image extension in order to succeed](/docs/extension-guide/create-extension/why-dockerfiles)
- [Building blocks of an extension](/docs/extension-guide/create-extension/building-blocks-extension)
- [Generating a build.Dockerfile for your application](/docs/extension-guide/create-extension/build-dockerfile)
- [Generating a run.Dockerfile for your application](/docs/extension-guide/create-extension/run-dockerfile)

<!--+if false+-->
---

<a href="/docs/extension-author-guide/create-extension/setup-local-environment" class="button bg-pink">Start Tutorial</a>
<!--+end+-->
<a href="/docs/extension-guide/create-extension/setup-local-environment" class="button bg-pink">Start Tutorial</a>
<!--+end+-->
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
+++
title="Generating a build.Dockerfile"
weight=404
aliases = [
"/docs/extension-author-guide/create-extension/build-dockerfile/",
]
+++

<!-- test:suite=dockerfiles;weight=4 -->
Expand Down Expand Up @@ -100,5 +103,5 @@ Let's take a look at how the `samples/curl` extension fixes the error by switchi
<!--+ if false+-->
---

<a href="/docs/extension-author-guide/create-extension/run-dockerfile" class="button bg-pink">Next Step</a>
<a href="/docs/extension-guide/create-extension/run-dockerfile" class="button bg-pink">Next Step</a>
<!--+ end +-->
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
+++
title="Building blocks of a CNB Image Extension"
weight=403
aliases = [
"/docs/extension-author-guide/building-blocks-extension/"
]
+++

<!-- test:suite=dockerfiles;weight=3 -->
Expand Down Expand Up @@ -46,5 +49,5 @@ We'll take a closer look at the executables for the `tree` extension in the next
<!--+ if false+-->
---

<a href="/docs/extension-author-guide/create-extension/build-dockerfile" class="button bg-pink">Next Step</a>
<a href="/docs/extension-guide/create-extension/build-dockerfile" class="button bg-pink">Next Step</a>
<!--+ end +-->
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
+++
title="Generating a run.Dockerfile"
weight=405
aliases = [
"/docs/extension-author-guide/run-dockerfile/"
]
+++

<!-- test:suite=dockerfiles;weight=5 -->
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
+++
title="Set up your local environment"
weight=401
aliases = [
"/docs/extension-author-guide/create-extension/setup-local-environment/",
]
+++

<!-- test:suite=dockerfiles;weight=1 -->
Expand Down Expand Up @@ -75,5 +78,5 @@ git clone https://github.com/buildpacks/samples.git
<!--+ if false +-->
---

<a href="/docs/extension-author-guide/create-extension/why-dockerfiles" class="button bg-pink">Next Step</a>
<a href="/docs/extension-guide/create-extension/why-dockerfiles" class="button bg-pink">Next Step</a>
<!--+ end+-->
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
+++
title="Why Dockerfiles"
weight=402
aliases = [
"/docs/extension-author-guide/create-extension/why-dockerfiles/",
]
+++

<!-- test:suite=dockerfiles;weight=2 -->
Expand Down Expand Up @@ -94,5 +97,5 @@ Let's take a look at how the `samples/tree` extension installs `tree` on the bui
<!--+ if false+-->
---

<a href="/docs/extension-author-guide/create-extension/building-blocks-extension" class="button bg-pink">Next Step</a>
<a href="/docs/extension-guide/create-extension/building-blocks-extension" class="button bg-pink">Next Step</a>
<!--+ end +-->
2 changes: 1 addition & 1 deletion content/docs/features/dockerfiles.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ An image extension could be defined with the following directory:
respectively (in the [initial implementation](#phased-approach), only limited `run.Dockerfile`s are allowed).

For more information and to see a build in action,
see [authoring an image extension](/docs/extension-author-guide/create-extension).
see [authoring an image extension](/docs/extension-guide/create-extension).

## A platform's perspective

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ For older platforms (platform API version 0.9 and below), arguments in `args` wi

Platform 0.10 introduces image extensions as experimental components for customizing build and run-time base images (see [here](/docs/features/dockerfiles) for more information).

For more information, see [authoring an image extension](/docs/extension-author-guide/create-extension).
For more information, see [authoring an image extension](/docs/extension-guide/create-extension).