From 47e7f55782fd7b191bf113f2fe4334bea835016c Mon Sep 17 00:00:00 2001 From: EvB Date: Tue, 27 Dec 2016 16:54:53 -0500 Subject: [PATCH] doc(README): render arch diagram --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ad5b080db..df0967435 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ![Docker Repository on Quay](https://quay.io/repository/quay/quay/status?token=7bffbc13-8bb0-4fb4-8a70-684a0cf485d3 "Docker Repository on Quay") -**Note**: The `master` branch may be in an *unstable or even broken state* during development. +:warning: The `master` branch may be in an *unstable or even broken state* during development. Please use [releases] instead of the `master` branch in order to get stable binaries. ![Quay Logo](static/img/quay_preview.png) @@ -47,7 +47,6 @@ High-level features include: 1. **[Getting Started](#getting-started)** 1. [macOS](#macos) - 2. [Useful Docs](#useful-docs) 3. [Linux](#linux) 2. **[Development](#development)** 1. [PivotalTracker Integration](#pivotaltracker-integration) @@ -125,12 +124,12 @@ npm install npm link typescript ``` -### Useful docs +#### Useful docs -[docker](https://beta.docker.com/docs/mac/getting-started://beta.docker.com/docs/mac/getting-started) -[docker-machine](https://docs.docker.com/machine/install-machine://docs.docker.com/machine/install-machine) -[pyenv](https://github.com/yyuu/pyenv) -[pyenv-virtualenv](https://github.com/yyuu/pyenv-virtualenv) +* [docker](https://beta.docker.com/docs/mac/getting-started://beta.docker.com/docs/mac/getting-started) +* [docker-machine](https://docs.docker.com/machine/install-machine://docs.docker.com/machine/install-machine) +* [pyenv](https://github.com/yyuu/pyenv) +* [pyenv-virtualenv](https://github.com/yyuu/pyenv-virtualenv) @@ -162,13 +161,14 @@ Reference: PivotalTracker blog - [A Guide to GitHub’s Service Hook for Tracker ### Test Data -A SQLite database full of test data is committed to this git repository at `test/data/test.db`. +A SQLite database full of test data is committed to this git repository at [test/data/test.db](quay/test/data/test.db). This database is generated by executing `python initdb.py`. The username and password of the admin test account is `devtable` and `password`, respectively. ### Local Scripts Running the web server locally requires [goreman](https://github.com/mattn/goreman): + ``` go get github.com/mattn/goreman ``` @@ -180,7 +180,7 @@ go get github.com/mattn/goreman ### Development inside Docker -To build and run a development container, pass one argument to local-docker.sh: +To build and run a development container, pass one argument to [local-docker.sh](quay/local-docker.sh): - `buildman`: run the buildmanager - `dev`: run web server on port 5000 @@ -300,7 +300,12 @@ docker build -t $QUAY_TAG --build-arg RUN_TESTS=true . * [Quay Enterprise Documentation](https://tectonic.com/quay-enterprise/docs/latest) * [Quay.io Documentation](https://docs.quay.io) -### [Architecture at a Glance](https://docs.google.com/a/coreos.com/drawings/d/1J-YZs7aun1lLy-1wFwIZcBma5IJmZQ8WfgtEftHCKJ0/edit?usp=sharing) +### Architecture at a Glance + + + +Edit chart on Google Docs at [Architecture at a Glance](https://docs.google.com/a/coreos.com/drawings/d/1J-YZs7aun1lLy-1wFwIZcBma5IJmZQ8WfgtEftHCKJ0/edit?usp=sharing). + ### Terminology