split TODO in README and TODO. use stylesheets for asciidoc html documents

1 files changed, 56 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 00000000..b63fe6b7
--- /dev/null
+++ b/README
@@ -0,0 +1,56 @@
+About jenkins.debian.net
+========================
+:Author:           Holger Levsen
+:Authorinitials:   holger
+:EMail:            holger@layer-acht.org
+:Status:           in progress
+:lang:             en
+:Doctype:          article
+:Licence:	   GPLv2
+
+== About jenkins.debian.net
+
+* http://jenkins.debian.net is pretty much work in progress, (hopefully) doing something useful since October 15th 2012.
+* Join #debian-qa on irc.debian.org to report bugs or give other feedback! Use debian-qa@lists.debian.org if you prefer mail.
+* 'git clone git://git.debian.org/git/users/holger/jenkins.debian.net.git'
+* (virtual) hardware sponsored by http://www.profitbricks.com - currently it's just a server, but in future there will be installation and tests clients started on demand as well.
+* some stats are available at http://jenkins.debian.net/munin/jenkins-month.html
+
+== Jobs being run
+
+=== chroot-tests jobs
+
+* FIXME: describe them
+
+=== debian-installer jobs
+
+* FIXME: describe them
+
+=== webcheck jobs
+
+* FIXME: describe them
+
+== ToDo
+
+* There is still of work left, check the current link:http://jenkins.debian.net/userContent/todo.html[ToDo list].
+
+== Setup
+
+=== Installed software that makes jenkins.debian.net run
+
+* jenkins.debian.net runs Debian wheezy.
+* FIXME: describe how jenkins is installed + configured, basically put 'deb http://pkg.jenkins-ci.org/debian-stable binary/' into '/etc/apt/sources.list.d/jenkins.list' and `apt-get update`
+* needed packages are listed in 'update_jdn.sh' and which will also make sure they are installed
+** 'update_jdn.sh' is available in the git repo
+* package configuration is kept in that git repo and deployed by 'update_jdn.sh' as well.
+
+=== Installing jenkins-job-builder
+* rebuild python-jenkinsapi from sid for wheezy:
+* `pip install python-jenkins`
+* `git clone https://github.com/openstack-ci/jenkins-job-builder ; cd jenkins-job-builder ; python setup.py install`
+** actually https://github.com/h01ger/jenkins-job-builder is used atm.
+
+=== Using jenkins-job-builder
+
+* then run `cd /srv/jenkins/job-cfg ; jenkins-jobs update .` to update jobs
+* testing: `cd /srv/jenkins/job-cfg ; rm test-output/ -r ; mkdir test-output ; jenkins-jobs test . -o test-output/ ; ls test-output/`