Browse Source

Update README

This patch updates the README file to add links to documentation and
contact information.

Change-Id: Ia28c9fbd8ab7fb3c083259b2f85b5f04a702343f
Major Hayden 2 years ago
parent
commit
95fb4b1983
2 changed files with 40 additions and 4 deletions
  1. 40
    4
      README.rst
  2. BIN
      doc/source/monitorstack-text.png

+ 40
- 4
README.rst View File

@@ -1,5 +1,5 @@
1
-monitorstack
2
-============
1
+.. image:: doc/source/monitorstack-text.png
2
+    :alt: monitorstack text
3 3
 
4 4
 .. list-table::
5 5
     :stub-columns: 1
@@ -12,6 +12,42 @@ monitorstack
12 12
 .. |codecov| image:: https://img.shields.io/codecov/c/github/major/monitorstack.svg
13 13
     :alt: Coverage Status
14 14
 
15
-Monitoring plugins for OpenStack.
15
+The monitorstack project provides a framework for writing monitoring plugins
16
+that output data in various formats for different monitoring systems.
17
+Developers can quickly add new monitoring plugins (along with tests) without
18
+worrying about how to format the data.
16 19
 
17
-*Work in progress.*
20
+For more details, including how to install/configure, a usage guide, and a
21
+developer guide, review the `monitorstack documentation`_.
22
+
23
+.. _monitorstack documentation: https://docs.openstack.org/developer/monitorstack/
24
+
25
+Requirements
26
+------------
27
+
28
+Python 2.7 or higher is required for monitorstack.
29
+
30
+Each commit is tested against Python 2.7, 3.3, 3.4, 3.5, and pypy.
31
+
32
+License
33
+-------
34
+
35
+Apache 2.0
36
+
37
+Community
38
+---------
39
+
40
+The monitorstack project is managed by the `OpenStack-Ansible community`_, but
41
+it can be used with or without OpenStack-Ansible.
42
+
43
+Contact information:
44
+
45
+* ``#openstack-ansible`` on Freenode IRC
46
+
47
+* `Launchpad Bugs`_
48
+
49
+* Send email to ``openstack-dev@lists.openstack.org`` with
50
+  ``[openstack-ansible][monitorstack]`` in the subject line.
51
+
52
+.. _OpenStack-Ansible community: https://wiki.openstack.org/wiki/OpenStackAnsible
53
+.. _Launchpad Bugs: https://bugs.launchpad.net/openstack-ansible

BIN
doc/source/monitorstack-text.png View File


Loading…
Cancel
Save