Add some doc.

alenz33 · Mar 27, 2015 · e47251f · e47251f
1 parent 0692aeb
commit e47251f
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 25 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -1,67 +1,61 @@
 Conduct API
 ===========
 
-conduct.buildsteps module
--------------------------
+Build steps
+-----------
 
 .. automodule:: conduct.buildsteps
     :members:
     :undoc-members:
 
 
-conduct.chain module
---------------------
+Build chain
+-----------
 
 .. automodule:: conduct.chain
     :members:
     :undoc-members:
 
 
-conduct.colors module
----------------------
+Colorizing stuff
+----------------
 
 .. automodule:: conduct.colors
     :members:
     :undoc-members:
 
 
-conduct.config module
----------------------
+Conduct configuration access
+----------------------------
 
 .. automodule:: conduct.config
     :members:
     :undoc-members:
 
 
-conduct.loggers module
-----------------------
+Custom logging
+--------------
 
 .. automodule:: conduct.loggers
     :members:
     :undoc-members:
 
 
-conduct.param module
---------------------
+Build step and chain parameters
+-------------------------------
 
 .. automodule:: conduct.param
     :members:
     :undoc-members:
 
 
-conduct.util module
--------------------
+Utility stuff
+-------------
 
 .. automodule:: conduct.util
     :members:
     :undoc-members:
 
 
 
-Module contents
----------------
-
-.. automodule:: conduct
-    :members:
-    :undoc-members:
 
diff --git a/doc/index.rst b/doc/index.rst
@@ -1,8 +1,3 @@
-.. conduct documentation master file, created by
-   sphinx-quickstart on Tue Feb  3 21:07:30 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to conduct's documentation!
 ===================================
 
@@ -11,6 +6,8 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   intro
+   start
    api
 
 

diff --git a/doc/intro.rst b/doc/intro.rst
@@ -0,0 +1,22 @@
+Introduction
+============
+
+conduct is a build system that is intended to be used as a standalone script (conduct.py) or in conjunction
+with some load balancer (e.g. via Jenkins).
+
+The idea is to checkout/install conduct to some system, give it a build chain config and the necessary
+parameters, and everything else shall be done automatically.
+That means:
+    * Bootstrapping of necessary tools
+    * Configuring necessary tools
+    * Building by using the given chain config and parameters
+    * Cleanup after the build
+    * Rollback the boostrapped packages (if desired)
+
+Basically, conduct's goals are:
+    * easy to configure the build process
+    * easy to use the build process
+    * easy to extend for special needs
+    * consistent logging
+    * automatic boostrapping
+    * great selection of standard build steps
diff --git a/doc/start.rst b/doc/start.rst
@@ -0,0 +1,3 @@
+Getting started
+===============
+