Skip to content

Commit 9570513

Browse files
authored
Merge pull request #39 from NETWAYS/docs/cleanup
Cleanup and update docs
2 parents 7fc645a + 4ad6232 commit 9570513

10 files changed

+4
-28
lines changed

README.md

+1-25
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,7 @@
22

33
This fork was created to provide bug fixes and maintenance.
44

5-
#### Table of Contents
6-
7-
1. [About](#about)
8-
2. [License](#license)
9-
3. [Support](#support)
10-
4. [Requirements](#requirements)
11-
5. [Documentation](#documentation)
12-
6. [Contributing](#contributing)
5+
You can find the complete documentation inside the [doc](doc/) folder.
136

147
## About
158

@@ -35,23 +28,6 @@ LICENSE file included in the source package.
3528

3629
Join the [Icinga community channels](https://icinga.com/community/) for questions.
3730

38-
## Requirements
39-
40-
* [Icinga Web 2](https://github.com/Icinga/icingaweb2) (>= 2.11)
41-
* [Icinga DB Web](https://github.com/Icinga/icingadb-web) (>= 1.02)
42-
* [Grafana](https://grafana.com/) (>= 7.0)
43-
* [Grafana Image Renderer](https://grafana.com/grafana/plugins/grafana-image-renderer/) (when using proxy access)
44-
* [PHP 8.1](https://www.php.net) (with curl and gd enabled)
45-
46-
A data source as a backend for Grafana. Either:
47-
48-
* [InfluxDB](https://docs.influxdata.com/influxdb/) (>= 1.0)
49-
* [Graphite](https://graphiteapp.org)
50-
51-
## Documentation
52-
53-
You can find the complete documentation inside the [doc](doc/) folder.
54-
5531
## Thanks
5632

5733
This module borrows a lot from https://github.com/Icinga/icingaweb2-module-generictts & https://github.com/Icinga/icingaweb2-module-pnp.

doc/02-installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ git clone "${REPO_URL}" "${TARGET_DIR}"
4444
Replace the version number with the latest available version from [Latest Release](https://github.com/NETWAYS/icingaweb2-module-grafana/releases/latest)
4545

4646
```
47-
MODULE_VERSION="2.0.1"
47+
MODULE_VERSION="3.0.0"
4848
ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules"
4949
REPO_URL="https://github.com/NETWAYS/icingaweb2-module-grafana"
5050
TARGET_DIR="${ICINGAWEB_MODULEPATH}/grafana"

doc/06-create-grafana-dashboards-influxdb.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ In this example we create a dashboard for the command ping6, open the menu and g
55

66
![Create new Dashboard](images/06-create-new.png)
77

8-
First go to the dashboard settings (![Settings](images/06-cog.png)) and change the name to `ITL-ping6`.
8+
First go to the dashboard settings and change the name to `ITL-ping6`.
99
Also if you want add description, row names, links etc.
1010
To save your changes, just hit the :floppy_disk: icon.
1111

doc/07-create-grafana-dashboards-graphite.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ In this example we create a dashboard for the command ping6, open the menu and g
55

66
![Create new Dashboard](images/06-create-new.png)
77

8-
First go to the dashboard settings (![Settings](images/06-cog.png)) and change the name to `ITL-ping6`.
8+
First go to the dashboard settings and change the name to `ITL-ping6`.
99
Also if you want add description, row names, links etc.
1010
To save your changes, just hit the :floppy_disk: icon.
1111

-46.9 KB
Binary file not shown.

doc/images/06-cog.png

-266 Bytes
Binary file not shown.
-42.2 KB
Binary file not shown.
Binary file not shown.
-41.9 KB
Binary file not shown.
-80.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)