Skip to content

Commit c4a922b

Browse files
author
Aaron Schlesinger
committed
doc(README.md): use footnote links
1 parent 437736a commit c4a922b

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
[![Build Status](https://travis-ci.org/deis/builder.svg?branch=master)](https://travis-ci.org/deis/builder) [![Go Report Card](http://goreportcard.com/badge/deis/builder)](http://goreportcard.com/report/deis/builder) [![Docker Repository on Quay](https://quay.io/repository/deisci/builder/status "Docker Repository on Quay")](https://quay.io/repository/deisci/builder)
44

5-
Deis (pronounced DAY-iss) is an open source PaaS that makes it easy to deploy and manage applications on your own servers. Deis builds on [Kubernetes](http://kubernetes.io/) to provide a lightweight, easy and secure way to deploy your code to production.
5+
Deis (pronounced DAY-iss) is an open source PaaS that makes it easy to deploy and manage applications on your own servers. Deis builds on [Kubernetes][k8s-home] to provide a lightweight, easy and secure way to deploy your code to production.
66

77
For more information on the Deis workflow, please visit the main project page at https://github.com/deis/workflow.
88

99
## Beta Status
1010

11-
This Deis component is currently in beta status, and we welcome your input! If you have feedback, please [submit an issue](https://github.com/deis/builder/issues). If you'd like to participate in development, please read the "Development" section below and [submit a pull request](https://github.com/deis/builder/pulls).
11+
This Deis component is currently in beta status, and we welcome your input! If you have feedback, please [submit an issue][issues]. If you'd like to participate in development, please read the "Development" section below and [submit a pull request][prs].
1212

1313
# About
1414

@@ -17,8 +17,8 @@ The builder is primarily a git server that responds to `git push`es from clients
1717
1. Executes the `git-receive-pack` or `git-upload-pack` hooks (as appropriate)
1818
2. Calls `git archive` to produce a tarball (i.e. a `.tar.gz` file) on the local file system
1919
3. Saves the tarball to centralized object storage according to the following rules:
20-
- If the `DEIS_OUTSIDE_STORAGE` environment variable exists, saves to the [S3 API](http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html) compatible server at `https://$DEIS_OUTSIDE_STORAGE`
21-
- Otherwise, if the `DEIS_MINIO_SERVICE_HOST` and `DEIS_MINIO_SERVICE_PORT` environment variables exist (these are standard [Kubernetes service discovery environment variables](http://kubernetes.io/docs/user-guide/services/#environment-variables)), saves to the [S3 API](http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html) compatible server at `http://$DEIS_MINIO_SERVICE_HOST:$DEIS_MINIO_SERVICE_HOST`
20+
- If the `DEIS_OUTSIDE_STORAGE` environment variable exists, saves to the [S3 API][s3-api-ref] compatible server at `https://$DEIS_OUTSIDE_STORAGE`
21+
- Otherwise, if the `DEIS_MINIO_SERVICE_HOST` and `DEIS_MINIO_SERVICE_PORT` environment variables exist (these are standard [Kubernetes service discovery environment variables](http://kubernetes.io/docs/user-guide/services/#environment-variables)), saves to the [S3 API][s3-api-ref] compatible server at `http://$DEIS_MINIO_SERVICE_HOST:$DEIS_MINIO_SERVICE_HOST`
2222
4. Starts a new [Kubernetes Pod](http://kubernetes.io/docs/user-guide/pods/) to build the code, according to the following rules:
2323
- If a `Dockerfile` is present in the codebase, starts a [`dockerbuilder`](https://github.com/deis/dockerbuilder) pod, configured to download the code to build from the URL computed in the previous step.
2424
- Otherwise, starts a [`slugbuilder`](https://github.com/deis/slugbuilder) pod, configured to download the code to build from the URL computed in the previous step.
@@ -29,8 +29,8 @@ The Deis project welcomes contributions from all developers. The high level proc
2929

3030
* Fork this repository
3131
* Make your changes
32-
* [Submit a pull request](https://github.com/deis/builder/pulls) (PR) to this repository with your changes, and unit tests whenever possible.
33-
* If your PR fixes any [issues](https://github.com/deis/builder/issues), make sure you write `Fixes #1234` in your PR description (where `#1234` is the number of the issue you're closing)
32+
* [Submit a pull request][prs] (PR) to this repository with your changes, and unit tests whenever possible.
33+
* If your PR fixes any [issues][issues], make sure you write `Fixes #1234` in your PR description (where `#1234` is the number of the issue you're closing)
3434
* The Deis core contributors will review your code. After each of them sign off on your code, they'll label your PR with `LGTM1` and `LGTM2` (respectively). Once that happens, you may merge.
3535

3636
## Docker Based Development Environment
@@ -74,4 +74,8 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use
7474
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
7575

7676

77+
[s3-api-ref]: http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html
7778
[install-k8s]: http://kubernetes.io/gettingstarted/
79+
[k8s-home]: http://kubernetes.io
80+
[issues]: https://github.com/deis/builder/issues
81+
[prs]: https://github.com/deis/builder/pulls

0 commit comments

Comments
 (0)