Commit 79201760 authored by Micha Mueller's avatar Micha Mueller
Browse files

Embed README.md files into doxygen documentation

parent 113f7acc
# DCDB
The *DataCenter* *DataBase* (DCDB) is a monitoring framework targeted at HPC environments. The framework consists of the three main parts:
The *DataCenter* *DataBase* (DCDB) is a modular, continuous and holistic monitoring framework targeted at HPC environments. The framework consists of the three main parts:
* _Storage_ _Backend_: Here all the collected data is stored. By default a Cassandra database is used but the framework is intended to support usage of other data storage solutions as well.
* _Collect_ _Agent_: The collect agent functions as intermediary between one storage backend and one or multiple pushers.
......@@ -58,3 +58,14 @@ Libdcdb is licensed under the terms and conditions of the GNU LESSER
GENERAL PUBLIC LICENSE (Version 2.1 or later).
See the `LICENSE` file for more information.
<!---
TODO:
write pages for:
-how to use dcdb
-architecture of dcdb
-develop plugin for pusher/analyzer
-develop for framework itself
-dig deeper into doxygen to get a beatiful documentation. perhaps use
markdown files for pages (for tutorials, architecture explanation)
-->
\ No newline at end of file
# Table of contents
# DCDB Data Analytics Framework
### Table of contents
1. [Introduction](#introduction)
2. [DCDBAnalytics](#dcdbanalytics)
1. [Global Configuration](#globalConfiguration)
......
# Table of contents
# DCDB Pusher
### Table of contents
1. [Introduction](#introduction)
2. [dcdbpusher](#dcdbpusher)
1. [Global Configuration](#globalConfiguration)
......@@ -28,7 +30,7 @@ Harvesting of the data is task of the dcdbpusher.
# dcdbpusher <a name="dcdbpusher"></a>
This is a general MQTT pusher which sends values of various sensors to the DCDB-database.
It ships with plugins for BACnet, IPMI, PDU(proprietary Power Delivery Unit, but could be used as XML plugin) ,percounter, SNMP and sysFS.
It ships with plugins for BACnet, IPMI, PDU(proprietary Power Delivery Unit, but could be used as XML plugin), perfcounter, SNMP and sysFS.
Build it by simply running
```bash
......
......@@ -771,7 +771,7 @@ WARN_LOGFILE = dox_stderr.txt
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = ./../analytics ./../collectagent ./../common ./../dcdbpusher ./../lib ./../tools
INPUT = ./../analytics ./../collectagent ./../common ./../dcdbpusher ./../lib ./../tools ./../README.md
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
......@@ -796,7 +796,7 @@ INPUT_ENCODING = UTF-8
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
FILE_PATTERNS = *.cpp *.h
FILE_PATTERNS = *.cpp *.h *.md
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
......@@ -811,7 +811,7 @@ RECURSIVE = YES
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE =
EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
......@@ -920,7 +920,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.
USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = ./../README.md
#---------------------------------------------------------------------------
# Configuration options related to source browsing
......
......@@ -24,31 +24,6 @@
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//================================================================================
/**
* @mainpage
* DataCenter DataBase (DCDB) is a modular, continuous and holistic monitoring
* framework for the HPC field. The framework consists of three main parts:
* pusher, collect agent and storage backend. Further on, DCDB ships with a
* small set of utility tools and allows access to the data store through
* libdcdb.
*
* See further:
* - @ref libdcdb "libdcdb" or
* - @subpage libdcdb "libdcdb"
* - @link pusher Pusher@endlink
*/
//
// TODO:
// write pages for:
// -how to use dcdb
// -architecture of dcdb
// -develop plugin for pusher/analyzer
// -develop for framework itself
// -dig deeper into doxygen to get a beatiful documentation. perhaps use
// markdown files for pages (for tutorials, architecture explanation)
//
/**
* @page libdcdb libdcdb
* The libdcdb library is a dynamic runtime library providing
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment