Merge ~richardw/jarmon/auto-apidocumentationv10.8pre1

 * Cleanup and add further doc strings for compatibility with yuidoc
 * Add a tool to automatically download and run yuidoc on the source tree
 * Add a tool to automatically create a releasable source archive containing apidocs
 * Add documentation of the apidoc and release tools.
 * Rearrange the source tree - moving all examples into the docs/examplesfolder

1 files changed, 67 insertions, 0 deletions

diff --git a/docs/examples/nginx.conf.example b/docs/examples/nginx.conf.example
new file mode 100644
index 0000000..3cfe830
--- /dev/null
+++ b/docs/examples/nginx.conf.example
@@ -0,0 +1,67 @@
+# This is an example of a minimal nginx config file, demonstrating:
+#  * how to set the mime type of served RRD files
+#  * how to configure nginx to compress the rrd files on the fly
+#  * how to setup a /data url alias pointing to the collectd RRD folder
+#
+# Add the relevant parts of this example config to your existing nginx config
+# files, or modify it and use it directly by running the following command line
+# from your Jarmon working directory "nginx -p . -c docs/nginx.conf.example" eg:
+#
+# richard@aziz:~/Projects/Jarmon/trunk$ nginx -p . -c docs/nginx.conf.example
+# [alert]: could not open error log file: open() "/var/log/nginx/error.log" failed (13: Permission denied)
+#
+# The error line is normal if you are running nginx as an unprivileged user.
+
+
+daemon off;
+pid nginx.pid;
+error_log nginx.error.log info;
+
+events {
+    worker_connections  1024;
+}
+
+http {
+    sendfile        on;
+    keepalive_timeout  65;
+    tcp_nodelay        on;
+
+    gzip  on;
+    gzip_disable "MSIE [1-6]\.(?!.*SV1)";
+
+    client_body_temp_path /tmp/nginx_body;
+    proxy_temp_path /tmp/nginx_proxy;
+    fastcgi_temp_path /tmp/nginx_fastcgi;
+
+    types {
+        application/octet-stream              rrd;
+        text/html                             html htm shtml;
+        text/css                              css;
+        text/xml                              xml rss;
+        image/gif                             gif;
+        image/jpeg                            jpeg jpg;
+        application/x-javascript              js;
+        text/plain                            txt;
+    }
+
+    server {
+        listen 8080 default;
+        server_name localhost;
+
+        access_log nginx.localhost.access.log;
+        error_log nginx.localhost.error.log;
+
+        gzip_types application/octet-stream;
+
+        location / {
+            root   .;
+            index  index.html;
+            autoindex on;
+        }
+
+        location /docs/examples/data {
+            alias /var/lib/collectd/rrd/aziz;
+            autoindex on;
+        }
+    }
+}