summaryrefslogtreecommitdiffstats
path: root/doc/reports.xml
diff options
context:
space:
mode:
authorJoey Hagedorn <hagedorn@mcs.anl.gov>2005-09-14 18:30:15 +0000
committerJoey Hagedorn <hagedorn@mcs.anl.gov>2005-09-14 18:30:15 +0000
commitb0d503f8615e167b3b26cc3c570f0d3d811edb1b (patch)
tree18bb2bf849f55d12da5b4bffb720499b15b01059 /doc/reports.xml
parent9f1f9d118f6d8fdcd45ccd5e3cbd83f3e2a87186 (diff)
downloadbcfg2-b0d503f8615e167b3b26cc3c570f0d3d811edb1b.tar.gz
bcfg2-b0d503f8615e167b3b26cc3c570f0d3d811edb1b.tar.bz2
bcfg2-b0d503f8615e167b3b26cc3c570f0d3d811edb1b.zip
working on the quickstart
(Logical change 1.313) git-svn-id: https://svn.mcs.anl.gov/repos/bcfg/trunk/bcfg2@1278 ce84e21b-d406-0410-9b95-82705330c041
Diffstat (limited to 'doc/reports.xml')
-rw-r--r--doc/reports.xml21
1 files changed, 15 insertions, 6 deletions
diff --git a/doc/reports.xml b/doc/reports.xml
index 61739528e..6b1e47926 100644
--- a/doc/reports.xml
+++ b/doc/reports.xml
@@ -4,10 +4,19 @@
<section>
<title>Quick Start</title>
- <para>Example report config</para>
- <para>put this line in cron to run nightly</para>
- <para>wait for the mail, check your website </para>
- <para>be sure sources are in your web directory.</para>
+ <para>Example report config:</para>
+ <para>Example Report Configuration Here</para>
+ <para>In order to run reports, you need to run the following command
+ regularly via <command>Cron</command>:
+ <command>GenerateHostInfo</command></para>
+ <para>Once configured correctly, just wait for the e-mail or check
+ look at the output html files with a web browser. You can run
+ <command>GenerateHostInfo</command> by hand if you would like
+ in order to try it out immediately. If you are trying to view a
+ HTML file and find that it doesn't work as expected, make sure
+ that the required source directory is in the same directory. They
+ are static, but might need to be moved from /(prefix)/share/bcfg2/
+ in to the directory from which you are viewing your reports.</para>
</section>
<section>
@@ -67,7 +76,7 @@
</section>
<section>
- <title>Reports</title>
+ <title>Reports Types</title>
<para>
There are a number of report types, and a number of delivery
@@ -171,6 +180,6 @@
<para>http://docs.python.org/lib/re-syntax.html</para>
- <para>How to write your own reports</para>
+ <para>Writing Custom Reports</para>
</section>
</chapter> \ No newline at end of file