From c451b744ff8ecde55b5ed3c7537018098eeb237d Mon Sep 17 00:00:00 2001 From: EvB Date: Tue, 27 Dec 2016 16:27:22 -0500 Subject: [PATCH 1/3] doc(README): add pivotal-gh integration help [ #136707589] --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index fc980fddf..8830d9a3c 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,25 @@ npm link typescript [pyenv](https://github.com/yyuu/pyenv) [pyenv-virtualenv](https://github.com/yyuu/pyenv-virtualenv) +### Developing + +#### PivotalTracker Integration + +Tag a commit with the Tracker Story ID and GitHub automatically comments on your +story with the commit message. + +Add the following at the end of your commit message: + +``` +[(Finishes|Fixes|Delivers) #TRACKER_STORY_ID] +``` + +When you push to GitHub, the post-receive hook will then call back to Tracker +and put a comment on the story with a link to the commit on GitHub. When tagged +with "Finishes", the trigger will also click Finish on the story. + +Reference: PivotalTracker blog - [A Guide to GitHub’s Service Hook for Tracker](https://www.pivotaltracker.com/blog/guide-githubs-service-hook-tracker/) + ### Linux From 9bb1db0683a502f04feab28e66ef12b105911904 Mon Sep 17 00:00:00 2001 From: EvB Date: Tue, 27 Dec 2016 16:39:30 -0500 Subject: [PATCH 2/3] doc(README): add table of contents --- README.md | 41 +++++++++++++++++++++++++++++++++++------ 1 file changed, 35 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8830d9a3c..ad5b080db 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,33 @@ High-level features include: [Clair]: https://github.com/coreos/clair [Swagger]: http://swagger.io +## Table of Contents + +1. **[Getting Started](#getting-started)** + 1. [macOS](#macos) + 2. [Useful Docs](#useful-docs) + 3. [Linux](#linux) +2. **[Development](#development)** + 1. [PivotalTracker Integration](#pivotaltracker-integration) +3. **[Running and Testing](#running-and-testing)** + 1. [Test Data](#test-data) + 2. [Local Scripts](#local-scripts) + 3. [Development inside Docker](#development-inside-docker) + 4. [Adding a Python Dependency](#adding-a-python-dependency) + 5. [Running the Build System](#running-the-build-system) + 6. [To run individual tests](#to-run-individual-tests) + 1. [Pytest](#pytest) + 2. [Tox](#tox) + 7. [Running Migrations](#running-migrations) + 8. [How to run a build with tests for a push or merge](#how-to-run-a-build-with-tests-for-a-push-or-merge) +4. **[Documentation](#documentation)** + 1. [Architecture at a Glance](#architecture-at-a-glance) + 2. [Terminology](#terminology) + 1. [Organizations](#organizations) + 2. [Concepts](#concepts) + 3. [Software](#software) + + ## Getting Started ### macOS @@ -105,9 +132,15 @@ npm link typescript [pyenv](https://github.com/yyuu/pyenv) [pyenv-virtualenv](https://github.com/yyuu/pyenv-virtualenv) -### Developing -#### PivotalTracker Integration + +### Linux + +TODO + +## Development + +### PivotalTracker Integration Tag a commit with the Tracker Story ID and GitHub automatically comments on your story with the commit message. @@ -125,10 +158,6 @@ with "Finishes", the trigger will also click Finish on the story. Reference: PivotalTracker blog - [A Guide to GitHub’s Service Hook for Tracker](https://www.pivotaltracker.com/blog/guide-githubs-service-hook-tracker/) -### Linux - -TODO - ## Running and Testing ### Test Data From 47e7f55782fd7b191bf113f2fe4334bea835016c Mon Sep 17 00:00:00 2001 From: EvB Date: Tue, 27 Dec 2016 16:54:53 -0500 Subject: [PATCH 3/3] 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