system-config/doc/source/stackalytics.rst
Ian Wienand 882b730fdf Update to openstackdocstheme
This modernises the openstack-infra documentation by switching to
openstackdocstheme.  Update dependencies as required.

To remove non-relevant stuff from conf.py, I have just taken the demo
file from openstackdocstheme and lightly modified it.

It seems later sphinx has included it's own ":file:" role which now
conflicts.  Change it it ":cgit_file:" in our documentation.  Remove
the custom header template which no longer applies.  Add the
post-2.0-pbr sphinx-based warning-as-error, which fixes the original
problem that I actually noticed that errors could slip through the
gate tests :)

Change-Id: Ic7bec57b971bb4c75fc839e7269d1f69a576b85c
2018-06-25 11:19:43 +10:00

40 lines
1.1 KiB
ReStructuredText

:title: Stackalytics
.. _stackalytics:
Stackalytics
############
Stackalytics is a service that collects and processes development activity
data such as commits, lines of code changed, code reviews and blueprints then
makes it possible to visualize it in a convenient web dashboard. The
Stackalytics dashboard makes it possible to view data by project, company,
contributor, and other factors.
The primary data sources for Stackalytics are the OpenStack Git repositories
and the Gerrit review history.
At a Glance
===========
:Hosts:
* http://stackalytics.openstack.org
:Puppet:
* https://git.openstack.org/cgit/openstack-infra/puppet-stackalytics/tree/
* :cgit_file:`modules/openstack_project/manifests/stackalytics.pp`
:Projects:
* https://git.openstack.org/cgit/openstack/stackalytics
:Documentation:
* https://wiki.openstack.org/wiki/Stackalytics
:Bugs:
* https://bugs.launchpad.net/stackalytics
Installation
============
Gerrit Events
-------------
Create a dedicated service account, described in :ref:`request-account-label`,
in order to properly stream events from :ref:`gerrit`.