Commit 593458ac authored by Paul Asmuth's avatar Paul Asmuth
Browse files

doc: sitemap

parent ff88e94d
Loading
Loading
Loading
Loading
+14 −18
Original line number Diff line number Diff line
@@ -57,25 +57,17 @@ class DocApp < Sinatra::Base
    render_with_layout
  end

  get "/documentation" do
  ["/documentation", "/documentation/*"].each do |route|
    get route do
      params[:splat] ||= ["index"]
      renderer = Redcarpet::Markdown.new(
        Redcarpet::Render::HTML.new(:no_link => true))
      @doc_yield = renderer.render(gfm(IO.read(
      File.join(BASEDIR, "src/index.md"))))
        File.join(BASEDIR, "src/#{params[:splat] * "/"}.md"))))
      @yield = render(:erb, IO.read(File.join(BASEDIR, 'web/documentation.erb')))
      render_with_layout
    end

=begin
  get '/*' do
    @route = params[:splat].first
    renderer = Redcarpet::Markdown.new(
      Redcarpet::Render::HTML.new(:no_link => true))
    @yield = renderer.render(gfm(IO.read(
      File.join(BASEDIR, "target/src/#{@route}.md"))))
    render_with_layout
  end
=end

  def render_with_layout
    render :erb, IO.read(File.join(BASEDIR, 'web/layout.erb'))
@@ -108,6 +100,10 @@ task :render do

  routes = ["/", "/documentation"]

  CONFIG["sitemap"].values.flatten.each do |page|
    routes << "/documentation#{page["url"]}"
  end

  routes.each do |path|
    puts "  + #{path}"
    builder.send(:build_path, path, target)
+17 −0
Original line number Diff line number Diff line
@@ -3,3 +3,20 @@

sitemap:

  fnordmetric_ui:
    -
      title: "Getting started"
      url: "/ui_index"
    -
      title: "Websocket Protocol"
      url: "/websocket_protocol"

  fnordmetric_classic:
    -
      title: "Getting started"
      url: "/classic_index"

  fnordmetric_enterprise:
    -
      title: "Getting started"
      url: "/ui_index"
+12 −0
Original line number Diff line number Diff line
The basic concept in FnordMetric is called a "gauge". A Gauge is a primitive data store for a numerical value over
time. A gauge has two dimensions: Value und Time. Gauges can be used in different modes like sum,
average, max/min, etcetara.

The FnordMetric core deals with processing data. There are two basic concepts:
events and gauges.

An Event is a piece of data that is sent to FnordMetric through one of the various
sources. This event is a JSON Object / Hash with almost no constraints on the schema.

You write event handlers in ruby that get invoked per incoming event and modify (increment,
set, etcetera) gauges.
+18 −22
Original line number Diff line number Diff line
@@ -2,29 +2,25 @@
  <div class="headbar">Documentation</div>
  <div id="navigation">
    <ul>
      <li><a href="#">Getting Started</a></li>
      <li><a href="/documentation">Overview</a></li>
    </ul>
    <a class="nav_title">FnordMetric UI</a>
    <ul>
      <li><a href="#">Getting Started</a></li>
      <li><a href="#">Getting Started</a></li>
      <li><a href="#">Getting Started</a></li>
      <li><a href="#">Getting Started</a></li>
    </ul>
    <a class="nav_title">FnordMetric Classic</a>
    <ul>
      <li><a href="#">Getting Started</a></li>
      <li><a href="#">Getting Started</a></li>
      <li><a href="#">Getting Started</a></li>
      <li><a href="#">Getting Started</a></li>
    </ul>
    <a class="nav_title">FnordMetric Enterprise</a>

    <% [
      ["FnordMetric UI", "fnordmetric_ui"],
      ["FnordMetric Classic", "fnordmetric_classic"],
      ["FnordMetric Enterprise", "fnordmetric_enterprise"]
    ].each do |(title, key)| %>
      <a class="nav_title"><%= title %></a>
      <ul>
      <li><a href="#">Getting Started</a></li>
      <li><a href="#">Getting Started</a></li>
      <li><a href="#">Getting Started</a></li>
      <li><a href="#">Getting Started</a></li>
        <% CONFIG["sitemap"][key].each do |page| %>
          <li>
            <a href="/documentation<%= page["url"] %>">
              <%= page["title"] %>
            </a>
          </li>
        <% end %>
      </ul>
    <% end %>
  </div>

  <div id="documentation">
+1 −1
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@
    <div id="wrap" class="<%= @doc_yield ? :large : nil %>" style="padding-top:25px;">
      <div id="header">
        <a class="menu" href="#">Support</a>
        <a class="menu" href="#">Github</a>
        <a class="menu" href="http://github.com/paulasmuth/fnordmetric" target="_blank">Github</a>
        <a class="menu" href="#">Screenshots</a>
        <a class="menu" href="/documentation">Documentation</a>
        <h1><a href="/">FnordMetric</a></h1>