diff --git a/.circleci/config.yml b/.circleci/config.yml index 3b43742..2550019 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -7,6 +7,7 @@ aliases: ignore: - master - docs + - gh-pages - &filter-only-master branches: only: master @@ -87,7 +88,7 @@ jobs: path: /tmp/circleci-test-results build-docs: - working_directory: ~/alexanderzobnin/grafana-zabbix + working_directory: ~/grafana-zabbix docker: - image: circleci/python:2.7 steps: @@ -107,14 +108,21 @@ jobs: - docs/site deploy-docs: - working_directory: ~/alexanderzobnin/grafana-zabbix + working_directory: ~/grafana-zabbix docker: - image: circleci/node:8 + environment: + GH_PAGES_BRANCH: gh-pages + CI_GIT_USER: CircleCI + CI_GIT_EMAIL: ci@grafana.com steps: + - add_ssh_keys: + fingerprints: + - "dc:7e:54:e0:aa:56:4d:e5:60:7b:f3:51:24:2d:d3:29" + - checkout - attach_workspace: - at: . - - run: ls -lh docs/site - + at: ../gh-pages + - run: ./.circleci/deploy-docs.sh workflows: version: 2 diff --git a/.circleci/deploy-docs.sh b/.circleci/deploy-docs.sh new file mode 100755 index 0000000..ab919f2 --- /dev/null +++ b/.circleci/deploy-docs.sh @@ -0,0 +1,24 @@ +#!/bin/bash + +# Exit script if you try to use an uninitialized variable. +set -o nounset +# Exit script if a statement returns a non-true return value. +set -o errexit +# Use the error status of the first failure, rather than that of the last item in a pipeline. +set -o pipefail + +echo "current dir: $(pwd)" + +# Setup git env +git config --global user.email $CI_GIT_EMAIL +git config --global user.name $CI_GIT_USER +echo "git user is $CI_GIT_USER ($CI_GIT_EMAIL)" + +git checkout -b $GH_PAGES_BRANCH +rm -rf * || true +mv ../gh-pages/docs/site/* ./ +git add --force . +git commit -m "build docs from commit ${CIRCLE_SHA1:0:7} (branch $CIRCLE_BRANCH)" +git log -n 3 + +git push origin $GH_PAGES_BRANCH --force diff --git a/CHANGELOG.md b/CHANGELOG.md index d1db11d..889c511 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -95,7 +95,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ### Changed - Template query format. New format is `{group}{host}{app}{item}`. It allows to use names with dot. Updated - [templating docs](http://docs.grafana-zabbix.org/guides/templating/#query-format), + [templating docs](https://alexanderzobnin.github.io/grafana-zabbix/guides/templating/#query-format), [#254](https://github.com/alexanderzobnin/grafana-zabbix/issues/254) - Update included dashboards. Add templated zabbix datasource and use it for all metrics. - Improved performance of groupBy() functions (at 6-10x faster than old). diff --git a/README.md b/README.md index e9ddae5..76338a0 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![Version](https://badge.fury.io/gh/alexanderzobnin%2Fgrafana-zabbix.svg)](https://github.com/alexanderzobnin/grafana-zabbix/releases) [![codecov](https://codecov.io/gh/alexanderzobnin/grafana-zabbix/branch/master/graph/badge.svg)](https://codecov.io/gh/alexanderzobnin/grafana-zabbix) [![Change Log](https://img.shields.io/badge/change-log-blue.svg?style=flat)](https://github.com/alexanderzobnin/grafana-zabbix/blob/master/CHANGELOG.md) -[![Docs](https://img.shields.io/badge/docs-latest-red.svg?style=flat)](http://docs.grafana-zabbix.org) +[![Docs](https://img.shields.io/badge/docs-latest-red.svg?style=flat)](https://alexanderzobnin.github.io/grafana-zabbix) [![Twitter URL](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Follow)](https://twitter.com/alexanderzobnin) [![Donate](https://img.shields.io/badge/donate-paypal-2c9eda.svg?style=flat&colorA=0b3684)](https://paypal.me/alexanderzobnin/10) @@ -14,12 +14,12 @@ Visualize your Zabbix metrics with the leading open source software for time ser ## Features -- Select multiple metrics [by using Regex](http://docs.grafana-zabbix.org/guides/gettingstarted/#multiple-items-on-one-graph) -- Create interactive and reusable dashboards with [template variables](http://docs.grafana-zabbix.org/guides/templating/) +- Select multiple metrics [by using Regex](https://alexanderzobnin.github.io/grafana-zabbix/guides/gettingstarted/#multiple-items-on-one-graph) +- Create interactive and reusable dashboards with [template variables](https://alexanderzobnin.github.io/grafana-zabbix/guides/templating/) - Show events on graphs with [Annotations](http://docs.grafana.org/reference/annotations/) - Display active problems with Triggers panel -- Transform and shape your data with [metric processing functions](http://docs.grafana-zabbix.org/reference/functions/) (Avg, Median, Min, Max, Multiply, Summarize, Time shift, Alias) -- Find problems faster with [Alerting](http://docs.grafana-zabbix.org/reference/alerting/) feature +- Transform and shape your data with [metric processing functions](https://alexanderzobnin.github.io/grafana-zabbix/reference/functions/) (Avg, Median, Min, Max, Multiply, Summarize, Time shift, Alias) +- Find problems faster with [Alerting](https://alexanderzobnin.github.io/grafana-zabbix/reference/alerting/) feature - Mix metrics from multiple data sources in the same dashboard or even graph - Discover and share [dashboards](https://grafana.com/dashboards) in the official library @@ -34,20 +34,20 @@ Install by using `grafana-cli` grafana-cli plugins install alexanderzobnin-zabbix-app ``` -Or see more installation options in [docs](http://docs.grafana-zabbix.org/installation/). +Or see more installation options in [docs](https://alexanderzobnin.github.io/grafana-zabbix/installation/). ## Getting started -First, [configure](http://docs.grafana-zabbix.org/installation/configuration/) Zabbix data source. Then you can create your first dashboard with step-by-step [Getting started guide](http://docs.grafana-zabbix.org/guides/gettingstarted/). +First, [configure](https://alexanderzobnin.github.io/grafana-zabbix/installation/configuration/) Zabbix data source. Then you can create your first dashboard with step-by-step [Getting started guide](https://alexanderzobnin.github.io/grafana-zabbix/guides/gettingstarted/). ## Documentation -- [About](http://docs.grafana-zabbix.org) -- [Installation](http://docs.grafana-zabbix.org/installation) -- [Getting Started](http://docs.grafana-zabbix.org/guides/gettingstarted) -- [Templating](http://docs.grafana-zabbix.org/guides/templating) -- [Alerting](http://docs.grafana-zabbix.org/reference/alerting/) -- [Metric processing functions](http://docs.grafana-zabbix.org/reference/functions/) +- [About](https://alexanderzobnin.github.io/grafana-zabbix) +- [Installation](https://alexanderzobnin.github.io/grafana-zabbix/installation) +- [Getting Started](https://alexanderzobnin.github.io/grafana-zabbix/guides/gettingstarted) +- [Templating](https://alexanderzobnin.github.io/grafana-zabbix/guides/templating) +- [Alerting](https://alexanderzobnin.github.io/grafana-zabbix/reference/alerting/) +- [Metric processing functions](https://alexanderzobnin.github.io/grafana-zabbix/reference/functions/) ## Community Resources, Feedback, and Support diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c51af8c..2066ded 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,35 +1,40 @@ site_name: Grafana-Zabbix Documentation -#site_url: http://docs.grafana-zabbix.org/ -#site_url: / site_description: Documentation for Grafana-Zabbix, Zabbix monitoring system plugin bundle for Grafana +site_url: https://alexanderzobnin.github.io/grafana-zabbix repo_url: https://github.com/alexanderzobnin/grafana-zabbix/ -edit_uri: blob/master/docs/sources/ -copyright: Copyright © 2015-2017, Alexander Zobnin +edit_uri: edit/docs/docs/sources/ +copyright: Copyright © 2015-2018, Alexander Zobnin docs_dir: sources -theme: readthedocs + +theme: + name: readthedocs + highlightjs: true + hljs_languages: + - yaml + - sql extra_css: - - css/custom.css + - css/custom.css pages: -- Project: - - 'About Grafana-Zabbix': 'index.md' - - 'Feature Highlights': 'features.md' -- Installation: - - 'Installation': 'installation/index.md' - - 'Configuration': 'installation/configuration.md' - - 'SQL Data Source Configuration': 'installation/configuration-sql.md' - - 'Provisioning': 'installation/provisioning.md' - - 'Upgrade': 'installation/upgrade.md' - - 'Troubleshooting': 'installation/troubleshooting.md' -- User Guides: - - 'Getting Started': 'guides/gettingstarted.md' - - 'Templating': 'guides/templating.md' -- Reference: - - 'Zabbix Datasource': 'reference/datasource-zabbix.md' - - 'Triggers Panel': 'reference/panel-triggers.md' - - 'Functions': 'reference/functions.md' - - 'Alerting': 'reference/alerting.md' - - 'Direct DB Connection': 'reference/direct-db-connection.md' -# - Tutorials: -# - 'Building Host Dashboard': 'tutorials/host_dashboard.md' + - Project: + - 'About Grafana-Zabbix': 'index.md' + - 'Feature Highlights': 'features.md' + - Installation: + - 'Installation': 'installation/index.md' + - 'Configuration': 'installation/configuration.md' + - 'SQL Data Source Configuration': 'installation/configuration-sql.md' + - 'Provisioning': 'installation/provisioning.md' + - 'Upgrade': 'installation/upgrade.md' + - 'Troubleshooting': 'installation/troubleshooting.md' + - User Guides: + - 'Getting Started': 'guides/gettingstarted.md' + - 'Templating': 'guides/templating.md' + - Reference: + - 'Zabbix Datasource': 'reference/datasource-zabbix.md' + - 'Triggers Panel': 'reference/panel-triggers.md' + - 'Functions': 'reference/functions.md' + - 'Alerting': 'reference/alerting.md' + - 'Direct DB Connection': 'reference/direct-db-connection.md' + # - Tutorials: + # - 'Building Host Dashboard': 'tutorials/host_dashboard.md' diff --git a/docs/sources/features.md b/docs/sources/features.md index e61732a..08f882a 100644 --- a/docs/sources/features.md +++ b/docs/sources/features.md @@ -7,11 +7,11 @@ Grafana in couple with Grafana-Zabbix plugin allows to create great dashboards. features: - Rich graphing features -- Create interactive and reusable dashboards with [template variables](http://docs.grafana-zabbix.org/guides/templating/) +- Create interactive and reusable dashboards with [template variables](/guides/templating/) - Show events on graphs with [Annotations](http://docs.grafana.org/reference/annotations/) -- Select multiple metrics [by using Regex](http://docs.grafana-zabbix.org/guides/gettingstarted/#multiple-items-on-one-graph) +- Select multiple metrics [by using Regex](/guides/gettingstarted/#multiple-items-on-one-graph) - Display active problems with Triggers panel -- Transform and shape your data with [metric processing functions](http://docs.grafana-zabbix.org/reference/functions/) (Avg, Median, Min, Max, Multiply, Summarize, Time shift, Alias) -- Find problems faster with [Alerting](http://docs.grafana-zabbix.org/reference/alerting/) feature +- Transform and shape your data with [metric processing functions](/reference/functions/) (Avg, Median, Min, Max, Multiply, Summarize, Time shift, Alias) +- Find problems faster with [Alerting](/reference/alerting/) feature - Mix metrics from multiple data sources in the same dashboard or even graph - Discover and share [dashboards](https://grafana.com/dashboards) in the official library diff --git a/src/datasource-zabbix/metric-function-editor.directive.js b/src/datasource-zabbix/metric-function-editor.directive.js index b87ff90..03d07ae 100644 --- a/src/datasource-zabbix/metric-function-editor.directive.js +++ b/src/datasource-zabbix/metric-function-editor.directive.js @@ -2,7 +2,7 @@ import angular from 'angular'; import _ from 'lodash'; import $ from 'jquery'; -const DOCS_FUNC_REF_URL = 'http://docs.grafana-zabbix.org/reference/functions/'; +const DOCS_FUNC_REF_URL = 'https://alexanderzobnin.github.io/grafana-zabbix/reference/functions/'; angular .module('grafana.directives') diff --git a/src/plugin.json b/src/plugin.json index 785d018..0e4f962 100644 --- a/src/plugin.json +++ b/src/plugin.json @@ -16,7 +16,7 @@ }, "links": [ {"name": "GitHub", "url": "https://github.com/alexanderzobnin/grafana-zabbix"}, - {"name": "Docs", "url": "http://docs.grafana-zabbix.org"}, + {"name": "Docs", "url": "https://alexanderzobnin.github.io/grafana-zabbix"}, {"name": "License", "url": "https://github.com/alexanderzobnin/grafana-zabbix/blob/master/LICENSE"} ], "screenshots": [