[03/11] incubator-trafficcontrol git commit: add building doc to development page

[fr...@apache.org]

add building doc to development page

(cherry picked from commit 1c84235d94831b215e94c32bffebd7189ea2c285)


Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/0a6cf8bd
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/0a6cf8bd
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/0a6cf8bd

Branch: refs/heads/2.0.x
Commit: 0a6cf8bdf0f197f109e7a6c4ca15d810229afd89
Parents: 875760a
Author: Dan Kirkwood <da...@gmail.com>
Authored: Tue Jun 13 13:38:39 2017 -0600
Committer: Eric Friedrich <fr...@apache.org>
Committed: Wed Jun 14 15:50:49 2017 -0400

----------------------------------------------------------------------
 docs/source/development/building.rst | 53 +++++++++++++++++++++++++++++++
 docs/source/development/index.rst    |  1 +
 2 files changed, 54 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/0a6cf8bd/docs/source/development/building.rst
----------------------------------------------------------------------
diff --git a/docs/source/development/building.rst b/docs/source/development/building.rst
new file mode 100644
index 0000000..addb27e
--- /dev/null
+++ b/docs/source/development/building.rst
@@ -0,0 +1,53 @@
+Building Traffic Control Components
+===================================
+
+Build using docker-compose
+--------------------------
+
+This is the easiest way to build all the components of Traffic Control;
+all requirements are automatically loaded into the image used to build
+each component.
+
+Requirements
+~~~~~~~~~~~~
+
+-  ``docker`` (https://docs.docker.com/engine/installation/)
+-  ``docker-compose`` (https://docs.docker.com/compose/install/)
+   (optional, but recommended)
+
+If ``docker-compose`` is not available, the ``pkg`` script will
+automatically download and run it in a container. This is noticeably
+slower than running it natively.
+
+Steps
+~~~~~
+
+From the top level of the incubator-trafficcontrol directory. The source
+in the current directory is used for the process. One or more components
+(with \_build suffix added) can be added on the command line.
+
+This is all run automatically by the ``pkg`` script at the root of the
+repository.
+
+::
+
+    $ ./pkg -?
+    Usage: ./pkg [options] [projects]
+        -q      Quiet mode. Supresses output.
+        -v      Verbose mode. Lists all build output.
+        -l      List available projects.
+
+        If no projects are listed, all projects will be packaged.
+        Valid projects:
+                - traffic_portal_build
+                - traffic_router_build
+                - traffic_monitor_build
+                - source
+                - traffic_ops_build
+                - traffic_stats_build
+
+If no component names are provided on the command line, all components
+will be built.
+
+All rpms are copied to ``dist`` at the top level of the
+``incubator-trafficcontrol`` directory.

http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/0a6cf8bd/docs/source/development/index.rst
----------------------------------------------------------------------
diff --git a/docs/source/development/index.rst b/docs/source/development/index.rst
index 851e463..999025a 100644
--- a/docs/source/development/index.rst
+++ b/docs/source/development/index.rst
@@ -20,6 +20,7 @@ Use this guide to start developing applications that consume the Traffic Control
 .. toctree::
   :maxdepth: 2
 
+  building
   traffic_ops
   traffic_portal
   traffic_router