Merge branch 'main' into release/lifecycle/0.12.0

Author: sambhav

.github/bug_report.md

@@ -0,0 +1,27 @@
+### **Describe the bug**
+A clear and concise description of what the bug is.
+
+### **To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### **Expected behavior**
+A clear and concise description of what you expected to happen.
+
+### **Screenshots**
+If applicable, add screenshots or screen captures to help explain your problem.
+
+### **Additional context**
+Add any other context about the problem here.
+
+<hr/>
+
+<!--- Do not remove or change this in the issue description. Only update the details above this. --->
+**Note:**
+* If you want to work on an issue, you should check if it has already been assigned to anyone. **If the issue is free** and you would like to be assigned to it please comment on the issue.
+* If you are raising a new issue and want to work on it then also you should comment to get assigned.
+* Please **refrain from** adding labels to your issue/pull-request on your own. It is the job of the Project Admin and the Mentors to review your issue/pull-request and add labels accordingly.
+

content/docs/app-developer-guide/using-http-proxy.md

@@ -0,0 +1,59 @@
++++
+title="Using Buildpacks with a Proxy"
+weight=8
+summary="Learn how to use buildpacks behind a HTTP proxy."
++++
+
+Many university or corporate environments use a proxy to access HTTP and HTTPS resources on the web.  Proxies introduce two constraints on buildpack built applications:
+
+1. `pack` needs to download buildpacks through the proxies, and
+2. applications running in containers created by `pack` need to call APIs behind the proxy.
+
+We show how to solve both of these constraints.
+
+## Making `pack` Proxy Aware
+
+You may need the `pack` command-line tool to download buildpacks and images via your proxy.  Building an application with an incorrectly configured proxy results in errors such as the following:
+
+```console
+$ pack build sample-app --path samples/apps/java-maven --builder cnbs/sample-builder:bionic
+ERROR: failed to build: failed to fetch builder image 'index.docker.io/cnbs/sample-builder:bionic'
+: Error response from daemon: Get "https//registry-1.docker.io/v2/": context deadline exceeded
+```
+
+The `pack` tool uses the Docker daemon to manage the local image registry on your machine.  The `pack` tool will ask the Docker daemon to download buildpacks and images for you.  Because of this relationship, between `pack` and the Docker daemon, we need to configure the Docker daemon to use a HTTP proxy.  The approach to setting the HTTP proxy depends on your platform:
+
+
+### Docker Desktop (Windows and MacOS)
+Docker's documetation states "Docker Desktop lets you configure HTTP/HTTPS Proxy Settings and automatically propagates these to Docker".  Set the system proxy using the [MacOS documentation](https://support.apple.com/en-gb/guide/mac-help/mchlp2591/mac) or [Windows documentation](https://www.dummies.com/computers/operating-systems/windows-10/how-to-set-up-a-proxy-in-windows-10/).  The system proxy settings will be used by Docker Desktop.
+
+### Linux
+The Docker project documents [how to configure configure the HTTP/HTTPS proxy](https://docs.docker.com/config/daemon/systemd/#httphttps-proxy) settings for the Docker daemon on Linux.  You should configure the `HTTP_PROXY` and `HTTPS_PROXY` environment variables as part of the Docker daemon startup.
+
+## Proxy Settings for Buildpacks
+
+Buildpacks may also need to be aware of your http and https proxies at build time.  For example python, java and nodejs buildpacks need to be aware of proxies in order to resolve dependencies.  To make buildpacks aware of proxies, export the `http_proxy` and `https_proxy` environment variables before invoking `pack`.  For example:
+
+```console
+export http_proxy=http://user:[email protected]:3128
+export https_proxy=https://my-proxy.example.com:3129
+pack build sample-app --path samples/apps/java-maven --builder cnbs/sample-builder:bionic
+```
+
+## Making your Application Proxy Aware
+
+Your application may need to use http or https proxies to access web-based APIs.  In order to make proxy settings available inside containers you should edit your `~/.docker/config.json` file (`%USERPROFILE%\.docker\config.json` on Windows) to contain the proxy information.  The `httpProxy`, `httpsProxy` and `noProxy` properties of this configuration file are injected into containers at build time and at run time as the `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` environment variables respectively.  Both the http and https proxy settings are also injected in their lower-case form as `http_proxy` and `https_proxy`.
+
+```json
+{
+  "proxies": {
+    "default": {
+      "httpProxy":  "http://user:[email protected]:3128",
+      "httpsProxy": "https://my-proxy.example.com:3129",
+      "noProxy":    "internal.mycorp.example.com"
+    }
+  }
+}
+```
+
+If your application requires a http or https proxy, then you should prefer to read proxy information from the lower-case `http_proxy` and `https_proxy` variables.

content/docs/concepts/components/buildpack.md

@@ -5,39 +5,35 @@ weight=2
 
 ## What is a buildpack?
 
-A buildpack is a unit of work that inspects your app source code and formulates a plan to build and run your
-application.
+A buildpack is a set of executables that inspects your app source code and create a plan to build and run your application.
 
 <!--more-->
 
-Typical buildpacks are a set of at least three files:
+Typical buildpacks consist of at least three files:
 
 * `buildpack.toml` -- provides metadata about your buildpack
 * `bin/detect` -- determines whether buildpack should be applied
-* `bin/build` -- executes buildpack logic
+* `bin/build` -- executes build logic
 
 #### Meta-buildpack
 
 There is a different type of buildpack commonly referred to as a **meta-buildpack**. It contains only a 
 `buildpack.toml` file with an `order` configuration that references other buildpacks. This is useful for 
 composing more complex detection strategies.
 
-## Anatomy of a buildpack
+## Buildpack phases
 
-There are two essential phases that allow buildpacks to create a runnable image.
+There are two essential steps that allow buildpacks to create a runnable image.
 
 #### Detect
 
-A platform sequentially tests groups of buildpacks against your app's source code. The first group that deems itself 
-fit for your source code will become the selected set of buildpacks for your app. Detection criteria is specific to each 
-buildpack -- for instance, an **NPM buildpack** might look for a `package.json`, and a **Go buildpack** might look for 
-Go source files.
+A [platform][platform] sequentially tests [groups][buildpack-group] of buildpacks against your app's source code. The first group that deems itself fit for your source code will become the selected set of buildpacks for your app.
+
+Detection criteria is specific to each  buildpack -- for instance, an **NPM buildpack** might look for a `package.json`, and a **Go buildpack** might look for Go source files.
 
 #### Build
 
-During build the buildpacks contribute to the final application image. This contribution could be as simple as setting 
-some environment variables within the image, creating a layer containing a binary (e.g: node, python, or ruby), or 
-adding app dependencies (e.g: running `npm install`, `pip install -r requirements.txt`, or `bundle install`).
+During build the buildpacks contribute to the final application image. This contribution could be as simple as setting  some environment variables within the image, creating a layer containing a binary (e.g: node, python, or ruby), or adding app dependencies (e.g: running `npm install`, `pip install -r requirements.txt`, or `bundle install`).
 
 ## Distribution
 
@@ -48,4 +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/
 [package-a-buildpack]: /docs/buildpack-author-guide/package-a-buildpack/
+[platform]: /docs/concepts/components/platform