manual: restore documentation scaffold

Contributing to FnordMetric

===========================

To contribute, please fork the github repository, make your changes and run the 

specs, commit them to your github repository and send me a pull request.

Need help, head on over to our [Google Groups][1] page to discuss any ideas

that you might have.

### Ways to contribute to FnordMetric:

  + report bugs or suggest new features

  + suggest or implement new options for existing charts or new chart types

  + improve the documentation

  + publish howtos, tutorials and videos

  + add a new backend (requires c++ knowledge)

  + add a new render target (requires c++ knowledge)

  + many more! improve all the things :)

#### Individual Contributors to FnordMetric

+ Laura Schlimmer (http://github.com/lauraschlimmer)

+ Christian Parpart (http://github.com/trapni)

+ Finn Zirngibl (https://github.com/finnomenon)

+ Simon Menke (http://github.com/fd)

+ Bruno Michel (http://github.com/nono)

+ Marco Borromeo (http://github.com/mborromeo)

+ Leo Lou (http://github.com/l4u)

+ Andy Lindeman (http://github.com/alindeman)

+ Jurriaan Pruis (http://github.com/jurriaan)

+ Kacper Bielecki (http://github.com/kazjote)

+ John Murray (http://github.com/JohnMurray)

+ Lars Gierth (http://github.com/lgierth)

+ Ross Kaffenberger (http://github.com/rossta)

+ Kunal Modi (http://github.com/kunalmodi)

+ Michael Fairchild (http://github.com/fairchild)

+ James Cox (http://github.com/imajes)

+ Pieter Noordhuis (http://github.com/pietern)

+ Tadas Ščerbinskas (http://github.com/tadassce)

+ Sebastian Korfmann (http://github.com/skorfmann)

+ Paul Asmuth (http://github.com/paulasmuth)

[http://github.com/paulasmuth/fnordmetric/graphs/contributors](http://github.com/paulasmuth/fnordmetric/graphs/contributors)

#### Other Open Source Software included in FnordMetric

  + Marijn Haverbeke's CodeMirror --- javascript code editor (https://github.com/marijnh/codemirror)

  + FontAwesome --- icon font (http://fontawesome.io/)

Frequently Asked Questions

==========================

### I'm getting build errors when compiling the code

FnordMetric needs a reasonably modern C++ compiler and standard library. In most

cases where the code doesn't build it's due to some problem with the local build

environment. We always appreciate bug reports so we improve our build system, but

often the best workaround for the moment is to download a binary release from the

downloads page.

Installing PlotFX

======================

PlotFX is written in C++. You can either install a binary release or compile

from source. Once the installation is complete, you will have a `plotfx` binary

on your system.

You can find the complete [source code on Github](http://github.com/plotfx/plotfx)

### Compile from source

You need autotools and a modern c++ compiler. To compile fnordmetric from a git

checkout run:

    $ git clone https://github.com/paulasmuth/fnordmetric.git && cd fnordmetric

    $ ./autogen.sh

    $ ./configure

    $ make

    $ sudo make install

# PlotFX v0.1.0

PlotFX is a collection of lightweight tools for real-time metrics collection

and visualization with SQL. The tools allow you to record measurements and

build beautiful real-time dashboards within minutes. All using your favorite SQL

database (currently supported are MySQL, Postgres and EventQL).

<ul>

  <li>

    <h4 style="margin-bottom:.2em; font-size:16px;"><a href="/documentation/metric-collectd">metric-collectd</a></h4>

    <p>

      metric-collectd is a lightweight daemon that collects measurements and other

      timeseries data, pre-aggregates it and stores the resulting tuples into a

      backend database. metric-collectd can currently listen for samples in

      Text/StatsD or JSON format via UDP or HTTP. It can also pull samples via

      HTTP or SNMP.

    </p>

  </li>

  <li>

    <h4 style="margin-bottom:.2em; font-size:16px;"><a href="/documentation/metric-queryd">metric-queryd</a></h4>

    <p>

      metric-queryd is a simple HTTP service that executes SQL queries on a backend

      database and plots the results. The HTTP API allows you to create timeseries graphs

      and other visualizations using nothing but SQL. You can easily plug the returned

      charts into a HTML site to create a real-time SQL-powered dashboard.

    </p>

  </li>

</ul>

The two services, `metricd-collectd` and `metric-queryd` do not depend on each

other and don't share a lot of code. If you're only interested in the data capture

part or only in the visualization part, you can run only one of the services.

To get started with PlotFX, have a look at these pages:

[Getting Started](/documentation/getting-started),

[Data Model](/documentation/data-model)

<div class="notice">

  <div style="float:right;"><a class="github-button" data-style="mega" href="https://github.com/paulasmuth/fnordmetric" data-count-href="/paulasmuth/fnordmetric/stargazers" data-count-api="/repos/paulasmuth/fnordmetric#stargazers_count" data-count-aria-label="# stargazers on GitHub" aria-label="Star paulasmuth/fnordmetric on GitHub">View on GitHub</a></div>

  Join PlotFX development now on GitHub. We're always appreciating new pull requests, bugs and feature requests!

</div>

## Examples

Here are some example charts that were generated using `metric-queryd` and SQL to

give you some ideas on what is possible. Have a look at the

[full list of examples](/examples/) for more.

<div style="height: .6em;"></div>

_Example: Simple timeseries chart_

<a href="/examples/linecharts/simple_lines"><img src="/examples/linecharts/simple_lines/simple_lines.png" style="width: 100%;" /></a>

_Example: Chart with explicit domain and legend_

<a href="/examples/linecharts/explicit_domain"><img src="/examples/linecharts/explicit_domain/explicit_domain.png" style="width: 100%;" /></a>

_Example: Horizontal barchart_

<a href="/examples/barcharts/horizontal_bars"><img src="/examples/barcharts/horizontal_bars/horizontal_bars.png" style="width: 100%;" /></a>

_Example: Scatter chart with lables_

<a href="/examples/pointcharts/pointchart_with_labels"><img src="/examples/pointcharts/pointchart_with_labels/pointchart_with_labels.png" style="width: 100%;" /></a>

## Getting Started

To get started with PlotFX, have a look at the [Getting Started](/documentation/getting-started) and

[Data Model](/documentation/data-model) pages. If you have any questions please

don't hesitate to reach out via [Github Issues](http://github.com/paulasmuth/fnordmetric/issues)

or [the PlotFX google group](http://groups.google.com/group/fnordmetric).

<script async defer src="https://buttons.github.io/buttons.js"></script>

License

=======

Copyright (c) 2018, Paul Asmuth, Laura Schlimmer

All rights reserved.

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this

  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,

  this list of conditions and the following disclaimer in the documentation

  and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its

  contributors may be used to endorse or promote products derived from

  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE

FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER

CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.