new documentation TOS (c1e087e5) · Commits · github_fork / Clip

doc/Rakefile

+10 −12

Original line number	Diff line number	Diff line
		@@ -81,10 +81,12 @@ class DocApp < Sinatra::Base
		get route do
		params[:splat] \|\|= ["index"]
		@route = "/#{params[:splat] * "/"}"

		page = CONFIG["sitemap"].values.flatten.find{ \|p\| p["url"] == @route }
		page = CONFIG["sitemap"]
		.map{ \|_, t\| t["pages"]}
		.flatten
		.find{ \|p\| p["url"] == @route }
		raise "can't find doc page for: #{@route}" if page.nil?
		@title = "#{page["title"]} \| Documentation" if page

		renderer = Redcarpet::Markdown.new(
		Redcarpet::Render::HTML.new(:no_link => true))
		@doc_yield = md_post(renderer.render(md_pre(IO.read(
		@@ -126,17 +128,13 @@ task :render do
		routes = %w{
		/
		/examples
		/documentation
		/documentation/support
		/documentation/license
		/documentation/downloads
		/documentation/examples/fm_classic_simple_example
		/documentation/examples/fm_classic_full_example
		/screenshots}

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

		CONFIG["examples"].each do \|example_group\|
		example_group["examples"].each do \|example\|

doc/config.yml

+111 −6

Original line number	Diff line number	Diff line
		@@ -156,6 +156,117 @@ examples:
		# * multiple y axis

		sitemap:
		getting_started:
		title: "Using FnordMetric"
		pages:
		-
		title: "Installation"
		url: "/query_language/reference"
		-
		title: "Getting Started"
		url: "/query_language/reference"
		-
		title: "Commandline Interface"
		url: "/query_language/reference"
		-
		title: "Web Interface"
		url: "/query_language/reference"


		query_language:
		title: "Query Language"
		pages:
		-
		title: "Introduction"
		url: "/query_language/overview"
		-
		title: "Data Sources"
		url: "/query_language/reference"
		-
		title: "Chart Types"
		url: "/query_language/reference"
		-
		title: "Axis styles"
		url: "/query_language/reference"
		-
		title: "Legend styles"
		url: "/query_language/reference"
		-
		title: "Point and Line styles"
		url: "/query_language/reference"
		-
		title: "Multiple Domains"
		url: "/query_language/reference"
		-
		title: "Combining Charts"
		url: "/query_language/reference"

		charts:
		title: "Chart Types"
		pages:
		-
		title: "Line Charts"
		url: "/query_language/reference"
		-
		title: "Point Charts"
		url: "/query_language/reference"
		-
		title: "Area Charts"
		url: "/query_language/reference"
		-
		title: "Bar Charts"
		url: "/query_language/reference"

		data_sources:
		title: "Data Sources"
		pages:
		-
		title: "Query from CSV"
		url: "/query_language/reference"
		-
		title: "Query from MySQL"
		url: "/query_language/reference"
		-
		title: "Query from statsd"
		url: "/query_language/reference"

		cpp_api:
		title: "C++ API"
		pages:
		-
		title: "Introduction"
		url: "/query_language/reference"
		-
		title: "API Reference"
		url: "/query_language/reference"
		-
		title: "Examples"
		url: "/query_language/reference"

		dashboards:
		title: "Building Dashboards"
		pages:
		-
		title: "Dashboards"
		url: "/query_language/reference"
		-
		title: "HTML5 API Reference"
		url: "/query_language/reference"
		-
		title: "Examples"
		url: "/query_language/reference"

		hacking:
		title: "Hacking"
		pages:
		-
		title: "Contributing"
		url: "/enterprise_api_reference"
		-
		title: "Old Documentation"
		url: "/enterprise_usage"

		sitemap_leacy:

		fnordmetric_ui:
		-
		@@ -208,11 +319,5 @@ sitemap:
		-
		title: "HTTP API"
		url: "/enterprise_http_api"
		#-
		# title: "Clients"
		# url: "/enterprise_usage"
		#-
		# title: "Examples"
		# url: "/enterprise_examples"

doc/src/query_language/overview.md

0 → 100644

+0 −0

Empty file added.

doc/src/query_language/reference.md

0 → 100644

+0 −0

Empty file added.

doc/web/documentation.erb

+3 −13

Original line number	Diff line number	Diff line
		@@ -16,25 +16,15 @@
		<li class="<%= @route == "/index" ? :active : nil %>">
		<a href="/documentation">Overview</a>
		</li>
		<li class="<%= @route == "/downloads" ? :active : nil %>">
		<a href="/documentation/downloads">Downloads</a>
		</li>
		<li class="<%= @route == "/support" ? :active : nil %>">
		<a href="/documentation/support">Support</a>
		</li>
		<li class="<%= @route == "/license" ? :active : nil %>">
		<a href="/documentation/license">License</a>
		</li>
		</ul>

		<% [
		["FnordMetric UI", "fnordmetric_ui"],
		["FnordMetric Enterprise", "fnordmetric_enterprise"],
		["FnordMetric Classic", "fnordmetric_classic"]
		].each do \|(title, key)\| %>
		<a class="nav_title"><%= title %></a>
		<% CONFIG["sitemap"].each do \|_, topic\| %>
		<a class="nav_title"><%= topic["title"] %></a>
		<ul>
		<% CONFIG["sitemap"][key].each do \|page\| %>
		<% topic["pages"].each do \|page\| %>
		<li class="<%= @route == page["url"] ? :active : nil %>">
		<a href="/documentation<%= page["url"] %>">
		<%= page["title"] %>

Admin message