Merge pull request #86 from pando85/master

Fix index and broken links Signed-off-by: Ben Hale <[email protected]>
buildpacks · Jun 17, 2020 · 6f2d4f8 · 6f2d4f8
2 parents 6cd54c8 + 7785786
commit 6f2d4f8
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 49 deletions.
diff --git a/buildpack.md b/buildpack.md
@@ -15,31 +15,59 @@ The `ENTRYPOINT` of the OCI image contains logic implemented by the lifecycle th
 
 ## Table of Contents
 
-1. [Buildpack Interface](#buildpack-interface)
-   1. [Key](#key)
-   2. [Detection](#detection)
-   3. [Build](#build)
-   4. [Layer Types](#layer-types)
-2. [App Interface](#app-interface)
-3. [Phase #1: Detection](#phase-1-detection)
-4. [Phase #2: Analysis](#phase-2-analysis)
-5. [Phase #3: Build](#phase-3-build)
-6. [Phase #4: Export](#phase-4-export)
-7. [Launch](#launch)
-8. [Environment](#environment)
-   1. [Provided by the Lifecycle](#provided-by-the-lifecycle)
-   2. [Provided by the Platform](#provided-by-the-platform)
-   3. [Provided by the Buildpacks](#provided-by-the-buildpacks)
-9. [Security Considerations](#security-considerations)
-    1. [Assumptions of Trust](#assumptions-of-trust)
-    2. [Requirements](#requirements)
-10. [Data Format](#data-format)
-    1. [launch.toml (TOML)](#launchtoml-toml)
-    2. [Build Plan (TOML)](#build-plan-toml)
-    3. [Buildpack Plan (TOML)](#buildpack-plan-toml)
-    4. [Bill-of-Materials (TOML)](#bill-of-materials-toml)
-    5. [Layer Content Metadata (TOML)](#layer-content-metadata-toml)
-    6. [buildpack.toml (TOML)](#buildpacktoml-toml)
+- [Buildpack Interface Specification](#buildpack-interface-specification)
+  - [Table of Contents](#table-of-contents)
+  - [Buildpack Interface](#buildpack-interface)
+    - [Key](#key)
+    - [Detection](#detection)
+    - [Build](#build)
+    - [Layer Types](#layer-types)
+      - [Launch Layers](#launch-layers)
+      - [Build Layers](#build-layers)
+      - [Other Layers](#other-layers)
+  - [App Interface](#app-interface)
+  - [Phase #1: Detection](#phase-1-detection)
+    - [Purpose](#purpose)
+    - [Process](#process)
+      - [Order Resolution](#order-resolution)
+  - [Phase #2: Analysis](#phase-2-analysis)
+    - [Purpose](#purpose-1)
+    - [Process](#process-1)
+  - [Phase #3: Build](#phase-3-build)
+    - [Purpose](#purpose-2)
+    - [Process](#process-2)
+      - [Buildpack Plan Entry Refinements](#buildpack-plan-entry-refinements)
+      - [Layers](#layers)
+  - [Phase #4: Export](#phase-4-export)
+    - [Purpose](#purpose-3)
+    - [Process](#process-3)
+  - [Launch](#launch)
+    - [Purpose](#purpose-4)
+    - [Process](#process-4)
+  - [Environment](#environment)
+    - [Provided by the Lifecycle](#provided-by-the-lifecycle)
+      - [Layer Paths](#layer-paths)
+    - [Provided by the Platform](#provided-by-the-platform)
+    - [Provided by the Buildpacks](#provided-by-the-buildpacks)
+      - [Environment Variable Modification Rules](#environment-variable-modification-rules)
+        - [Delimiter](#delimiter)
+        - [Prepend](#prepend)
+        - [Append](#append)
+        - [Override](#override)
+        - [Default](#default)
+  - [Security Considerations](#security-considerations)
+    - [Assumptions of Trust](#assumptions-of-trust)
+    - [Requirements](#requirements)
+  - [Data Format](#data-format)
+    - [launch.toml (TOML)](#launchtoml-toml)
+    - [store.toml (TOML)](#storetoml-toml)
+    - [Build Plan (TOML)](#build-plan-toml)
+    - [Buildpack Plan (TOML)](#buildpack-plan-toml)
+    - [Bill-of-Materials (TOML)](#bill-of-materials-toml)
+    - [Layer Content Metadata (TOML)](#layer-content-metadata-toml)
+    - [buildpack.toml (TOML)](#buildpacktoml-toml)
+      - [Buildpack Implementations](#buildpack-implementations)
+      - [Order Buildpacks](#order-buildpacks)
 
 ## Buildpack Interface
 
@@ -93,8 +121,8 @@ Executable: `/bin/build <layers[EIC]> <platform[AR]> <plan[E]>`, Working Dir: `<
 | `/dev/stdout`                  | Logs (info)
 | `/dev/stderr`                  | Logs (warnings, errors)
 | `<plan>`                       | Refinements to the [Buildpack Plan](#buildpack-plan-toml) (TOML)
-| `<layers>/launch.toml`         | App metadata (see [launch.toml](#launch.toml-toml))
-| `<layers>/store.toml`          | Persistent metadata (see [store.toml](#store.toml-toml))
+| `<layers>/launch.toml`         | App metadata (see [launch.toml](#launchtoml-toml))
+| `<layers>/store.toml`          | Persistent metadata (see [store.toml](#storetoml-toml))
 | `<layers>/<layer>.toml`        | Layer metadata (see [Layer Content Metadata](#layer-content-metadata-toml))
 | `<layers>/<layer>/bin/`        | Binaries for launch and/or subsequent buildpacks
 | `<layers>/<layer>/lib/`        | Shared libraries for launch and/or subsequent buildpacks

diff --git a/distribution.md b/distribution.md
@@ -5,11 +5,11 @@ This document specifies the artifact format, delivery mechanism, and order resol
 
 ## Table of Contents
 
-1. [Order Resolution](#order-resolution)
-2. [Artifact Format](#artifact-format)
-   1. [Buildpack](#buildpack)
-   2. [Buildpackage](#buildpackage)
-
+- [Distribution Specification](#distribution-specification)
+  - [Table of Contents](#table-of-contents)
+  - [Artifact Format](#artifact-format)
+    - [Buildpack](#buildpack)
+    - [Buildpackage](#buildpackage)
 
 ## Artifact Format
 
@@ -54,4 +54,4 @@ For each listed stack, all associated buildpacks MUST be a candidate for detecti
 Each stack ID MUST only be present once.
 For a given stack, the `mixins` list MUST enumerate mixins such that no included buildpacks are missing a mixin for the stack.
 
-Fewer stack entries as well as additional mixins for a stack entry MAY be specified.
+Fewer stack entries as well as additional mixins for a stack entry MAY be specified.
diff --git a/extensions/bindings.md b/extensions/bindings.md
@@ -1,10 +1,26 @@
 # Bindings
+
 Bindings are exposed inside of a container during the detect, build, and launch phases of the lifecycle.  The contents of bindings MUST NOT be part of the image created after the detect and build phases.
 
+## Table of Contents
+
+- [Bindings](#bindings)
+  - [Table of Contents](#table-of-contents)
+  - [Detect and Build Phases](#detect-and-build-phases)
+    - [Metadata](#metadata)
+    - [Secret](#secret)
+    - [Example Directory Structure](#example-directory-structure)
+  - [Launch Phase](#launch-phase)
+    - [Metadata](#metadata-1)
+    - [Secret](#secret-1)
+    - [Example Directory Structure](#example-directory-structure-1)
+
 ## Detect and Build Phases
+
 Before initiating the detect or build phases on the build-image, the platform MUST provide any bindings as files in `<platform>/bindings/<binding-name>` with directory names matching the name of the binding.  Binding names MUST match `[a-z0-9\-\.]{1,253}`.
 
 ### Metadata
+
 Within each binding directory the platform MUST provide a `metadata` directory containing `kind` and `provider` files.  The value of the `kind` file MUST contain an abstract classification of the binding.  The value of the `provider` file MUST identify the provider of this binding.
 
 In addition to the required files, the `metadata` directory MAY contain additional metadata about the binding with file names and contents matching the metadata names and contents.
@@ -14,6 +30,7 @@ The collection of files within the directory MAY change between detect and build
 The contents of the files MAY change between detect and build phase pairs.  The contents of the files MUST NOT change during the detect and build phase pair.
 
 ### Secret
+
 Within each binding directory the platform MAY provide a `secret` directory containing the secret associated with the binding with filenames matching the secret key names.
 
 During the detect and build phases, if the `secret` directory exists, the contents of the files MAY be one of the following:
@@ -27,6 +44,7 @@ If the `secret` directory exists, the contents of the files MAY change between d
 
 
 ### Example Directory Structure
+
 ```plain
 <platform>
 └── bindings
@@ -47,9 +65,11 @@ If the `secret` directory exists, the contents of the files MAY change between d
 ```
 
 ## Launch Phase
+
 During the launch phase, the platform MUST provide any bindings as files in `$CNB_BINDINGS/<binding-name>` with directory names matching the name of the binding.  Binding names MUST match `[a-z0-9\-\.]{1,253}`.  The `CNB_BINDINGS` environment variable MUST be declared and can point to any valid filesystem location.
 
 ### Metadata
+
 Within each binding directory the platform MUST provide a `metadata` directory containing `kind` and `provider` files.  The value of the `kind` file MUST contain an abstract classification of the binding.  The value of the `provider` file MUST identify the provider of this binding.
 
 In addition to the required files, the `metadata` directory MAY contain additional metadata about the binding with file names and contents matching the metadata names and contents.
@@ -59,6 +79,7 @@ The collection of files within the directory MAY change between launches.  The c
 The contents of the files MAY change between launches.  The contents of the files MAY change during the launch phase.
 
 ### Secret
+
 Within each binding directory the platform MUST provide a `secret` directory containing the secret associated with the binding with filenames matching the secret key names.
 
 During the launch phase, the contents of the files MAY be one of the following:
@@ -71,6 +92,7 @@ The collection of files within the directory MAY change between launches.  The c
 The contents of the files MAY change between launches.  The contents of the files MAY change during the launch phase.
 
 ### Example Directory Structure
+
 ```plain
 custom-bindings-location
 ├── primary-db

diff --git a/platform.md b/platform.md
@@ -12,22 +12,25 @@ Examples of a platform might include:
 
 ## Table of Contents
 
-1. [Platform API Version](#platform-api-version)
-   1. [Compatibility Verification](#compatibility-verification)
-2. [Stacks](#stacks)
-   1. [Compatibility Guarantees](#compatibility-guarantees)
-   2. [Build Image](#build-image)
-   3. [Run Image](#run-image)
-3. [Buildpacks](#buildpacks)
-   1. [Buildpacks Directory Layout](#buildpacks-directory-layout)
-4. [Security Considerations](#security-considerations)
-5. [Additional Guidance](#additional-guidance)
-   1. [Environment](#environment)
-   2. [Run Image Rebasing](#run-image-rebasing)
-   3. [Caching](#caching)
-6. [Data Format](#data-format)
-   1. [order.toml (TOML)](#order.toml-(toml))
-   2. [group.toml (TOML)](#group.toml-(toml))
+- [Platform Interface Specification](#platform-interface-specification)
+  - [Table of Contents](#table-of-contents)
+  - [Platform API Version](#platform-api-version)
+    - [Compatibility Verification](#compatibility-verification)
+  - [Stacks](#stacks)
+    - [Compatibility Guarantees](#compatibility-guarantees)
+    - [Build Image](#build-image)
+    - [Run Image](#run-image)
+    - [Mixins](#mixins)
+  - [Buildpacks](#buildpacks)
+    - [Buildpacks Directory Layout](#buildpacks-directory-layout)
+  - [Security Considerations](#security-considerations)
+  - [Additional Guidance](#additional-guidance)
+    - [Environment](#environment)
+    - [Run Image Rebasing](#run-image-rebasing)
+    - [Caching](#caching)
+  - [Data Format](#data-format)
+    - [order.toml (TOML)](#ordertoml-toml)
+    - [group.toml (TOML)](#grouptoml-toml)
 
 
 ## Platform API Version