doc(README): add table of contents

This commit is contained in:
EvB 2016-12-27 16:39:30 -05:00
parent c451b744ff
commit 9bb1db0683

View file

@ -43,6 +43,33 @@ High-level features include:
[Clair]: https://github.com/coreos/clair [Clair]: https://github.com/coreos/clair
[Swagger]: http://swagger.io [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 ## Getting Started
### macOS ### macOS
@ -105,9 +132,15 @@ npm link typescript
[pyenv](https://github.com/yyuu/pyenv) [pyenv](https://github.com/yyuu/pyenv)
[pyenv-virtualenv](https://github.com/yyuu/pyenv-virtualenv) [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 Tag a commit with the Tracker Story ID and GitHub automatically comments on your
story with the commit message. 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 GitHubs Service Hook for Tracker](https://www.pivotaltracker.com/blog/guide-githubs-service-hook-tracker/) Reference: PivotalTracker blog - [A Guide to GitHubs Service Hook for Tracker](https://www.pivotaltracker.com/blog/guide-githubs-service-hook-tracker/)
### Linux
TODO
## Running and Testing ## Running and Testing
### Test Data ### Test Data