Add docs for grafana-dashboards command
Also rework index file to include README over a dedicated readme file. Change-Id: I70108fb627131e7a8bfec6e64cbfc093e65ca48b Signed-off-by: Paul Belanger <pabelanger@redhat.com>
This commit is contained in:
parent
562d075a46
commit
789bf1f3a2
53
doc/source/grafana-dashboard.rst
Normal file
53
doc/source/grafana-dashboard.rst
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
=================
|
||||||
|
grafana-dashboard
|
||||||
|
=================
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
========
|
||||||
|
|
||||||
|
``grafana-dashboard`` [options] <command> [<args>...]
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
===========
|
||||||
|
|
||||||
|
``grafana-dashboard`` is a CLI command to update Grafana dashboards from yaml
|
||||||
|
files.
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
=======
|
||||||
|
|
||||||
|
-h, --help Show the help.
|
||||||
|
--config-dir DIR Path to a config directory to pull \*.conf files from. This
|
||||||
|
file set is sorted, so as to provide a predictable parse
|
||||||
|
order if individual options are over-ridden. The set is
|
||||||
|
parsed after the file(s) specified via previous
|
||||||
|
--config-file, arguments hence over-ridden options in the
|
||||||
|
directory take precedence.
|
||||||
|
--config-file PATH Path to a config file to use. Multiple config files can be
|
||||||
|
specified, with values in later files taking precedence. The
|
||||||
|
default files used are: None.
|
||||||
|
-d, --debug Print debugging output(set logging level to DEBUG
|
||||||
|
instead of default WARNING level).
|
||||||
|
-v, --verbose Print more verbose output (set logging level to INFO
|
||||||
|
instead of default WARNING level).
|
||||||
|
--version Show program's version number and exit.
|
||||||
|
|
||||||
|
COMMANDS
|
||||||
|
========
|
||||||
|
|
||||||
|
Update Command
|
||||||
|
--------------
|
||||||
|
|
||||||
|
``grafana-dashboard`` [options] update <path>
|
||||||
|
|
||||||
|
Updates each specified dashboard to the lastest layout from parsed yaml files.
|
||||||
|
|
||||||
|
FILES
|
||||||
|
=====
|
||||||
|
|
||||||
|
/etc/grafyaml/grafyaml.conf
|
||||||
|
|
||||||
|
AUTHOR
|
||||||
|
======
|
||||||
|
|
||||||
|
.. include:: ../../AUTHORS
|
@ -1,20 +1,18 @@
|
|||||||
.. grafyaml documentation master file, created by
|
|
||||||
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
|
||||||
You can adapt this file completely to your liking, but it should at least
|
|
||||||
contain the root `toctree` directive.
|
|
||||||
|
|
||||||
Welcome to grafyaml's documentation!
|
Welcome to grafyaml's documentation!
|
||||||
========================================================
|
====================================
|
||||||
|
|
||||||
Contents:
|
.. include:: ../../README.rst
|
||||||
|
|
||||||
|
Contents
|
||||||
|
========
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
readme
|
|
||||||
installation
|
installation
|
||||||
usage
|
usage
|
||||||
contributing
|
contributing
|
||||||
|
grafana-dashboard
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
@ -1 +0,0 @@
|
|||||||
.. include:: ../../README.rst
|
|
@ -35,5 +35,8 @@ console_scripts =
|
|||||||
oslo.config.opts =
|
oslo.config.opts =
|
||||||
grafyaml = grafana_dashboards.builder:list_opts
|
grafyaml = grafana_dashboards.builder:list_opts
|
||||||
|
|
||||||
|
[pbr]
|
||||||
|
warnerrors = True
|
||||||
|
|
||||||
[upload_sphinx]
|
[upload_sphinx]
|
||||||
upload-dir = doc/build/html
|
upload-dir = doc/build/html
|
||||||
|
Loading…
x
Reference in New Issue
Block a user