| Version: | Unversioned directory |
|---|---|
| Date: | September 08, 2014 |
Objectives for these pages.
Major issues should continue to be tracked via heprez trac tickets but often a large number of smaller issues are dealt with when performing scrapes. The Trac interface is suited to long lived issues, whereas a more logging style of interface is useful to capture operational fixes and techniques.
Contents:
Usage guide:
Development docs:
Have formerly been using Trac wiki pages for documentation purpose, but that looses the intimate context of having documentation sources residing in the same repository as the code being developed, and suffers from inconvenient web interface text editing.
Seeing TODO items and logged fixes in the same commits as the code changes is invaluable. Also documentation remains visible from sources during downtime of server database.
Very structured information closely linked to bash functions should be logged within the bash functions themselves. For example:
Sphinx is run on G and the generated html is rsynced across to server, do that from G with:
cd ~/h
make