From 10ed38a150a95400ddc978f4197fb9add2e699a5 Mon Sep 17 00:00:00 2001 From: Alexander Zobnin Date: Sat, 9 Jan 2016 22:58:16 +0300 Subject: [PATCH] Added initial docs based on MkDocs. --- docs/mkdocs.yml | 38 ++++++++++++++++++++++++++++++ docs/sources/index.md | 33 ++++++++++++++++++++++++++ docs/sources/installation/index.md | 2 ++ 3 files changed, 73 insertions(+) create mode 100644 docs/mkdocs.yml create mode 100644 docs/sources/index.md create mode 100644 docs/sources/installation/index.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..ddddaee --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,38 @@ +site_name: Grafana-Zabbix Documentation +#site_url: http://docs.grafana.com/ +#site_url: / +site_description: Documentation for Grafana-Zabbix, Zabbix monitoring system plugin bundle for Grafana +repo_url: https://github.com/alexanderzobnin/grafana-zabbix/ +copyright: Copyright © 2014-2015, Alexander Zobnin + +docs_dir: sources +theme: readthedocs + + +pages: +- Project: + - 'About Grafana-Zabbix': 'index.md' +- Installation: + - 'Installation': 'installation/index.md' + +# - ['project/cla.md', 'Project', 'Contributor License Agreement'] + +# - ['installation/index.md', 'Installation', 'Installation'] +# - ['installation/troubleshooting.md', 'Installation', 'Troubleshooting'] +# - ['installation/migrating_to2.md', 'Installation', 'Migrating from v1.x to v2.x'] + +# - ['guides/basic_concepts.md', 'User Guides', 'Basic Concepts'] +# - ['guides/gettingstarted.md', 'User Guides', 'Getting Started'] +# - ['guides/whats-new-in-v2-6.md', 'User Guides', "What's New in Grafana v2.6"] +# - ['guides/whats-new-in-v2-5.md', 'User Guides', "What's New in Grafana v2.5"] +# - ['guides/whats-new-in-v2-1.md', 'User Guides', "What's New in Grafana v2.1"] +# - ['guides/whats-new-in-v2.md', 'User Guides', "What's New in Grafana v2.0"] +# - ['guides/screencasts.md', 'User Guides', 'Screencasts'] + +# - ['reference/graph.md', 'Reference', 'Graph Panel'] +# - ['reference/singlestat.md', 'Reference', 'Singlestat Panel'] +# - ['reference/table_panel.md', 'Reference', 'Table Panel'] +# - ['reference/dashlist.md', 'Reference', 'Dashboard List Panel'] + +# - ['tutorials/index.md', 'Tutorials', 'Tutorials'] +# - ['tutorials/hubot_howto.md', 'Tutorials', 'How To integrate Hubot and Grafana'] diff --git a/docs/sources/index.md b/docs/sources/index.md new file mode 100644 index 0000000..5a16ee2 --- /dev/null +++ b/docs/sources/index.md @@ -0,0 +1,33 @@ +page_title: About Grafana-Zabbix +page_description: Introduction to Grafana-Zabbix. + +# About Grafana-Zabbix + +Grafana-Zabbix is a plugin bundle for Grafana allowing to visualize monitoring data from Zabbix +and create dashboards for analyzing metrics and realtime monitoring. + +## Community resources, feedback, and support + +Thousands of organizations large and small rely on Grafana, and we have a vibrant and active community that constantly inspires us. + +Please don't hesitate to [open a new issue on Github](https://github.com/grafana/grafana/issues) +with your suggestions, ideas, and bug reports. + +Most of the new features and improvements that go into Grafana come from our users. We greatly value your feedback and suggestions; we consider them paramount to making the product better! + +If you have any troubles with Grafana or you just want clarification on a feature, there are +a number of ways to get help: + +- [Troubleshooting guide](/installation/troubleshooting/) +- Search closed and open [issues on GitHub](https://github.com/grafana/grafana/issues) +- [Gitter room](https://gitter.im/alexanderzobnin/grafana-zabbix) +- [Twitter](https://twitter.com/AlexanderZobnin) + +Or you can just send me [emai](mailto:alexanderzobnin@gmail.com). + +## License + +By utilizing this software, you agree to the terms of the included license. Grafana-Zabbix is +licensed under the Apache 2.0 agreement. See +[LICENSE](https://github.com/alexanderzobnin/grafana-zabbix/blob/master/LICENSE.md) for the full +license terms. \ No newline at end of file diff --git a/docs/sources/installation/index.md b/docs/sources/installation/index.md new file mode 100644 index 0000000..26bf6b5 --- /dev/null +++ b/docs/sources/installation/index.md @@ -0,0 +1,2 @@ +page_title: About Grafana-Zabbix +page_description: Introduction to Grafana-Zabbix. \ No newline at end of file