Skip to content

Commit 18f7257

Browse files
committed
docs(roles): correct icingaweb2 module descriptions against upstream
* `icingaweb2_module_generictts` README claimed the module rewrites ticket patterns in `notes` / `notes_url` fields and listed Jira / Redmine / Bugzilla as targets. Both were guesses. Upstream's own README says the module operates on acknowledgements, downtimes and comments and is generic about the ticket system. Correct the text. * `icingaweb2_module_fileshipper` README narrowed the Fileshipper's Import Source to "host / service definitions". Upstream describes it as an Import Source for CSV / JSON / YAML / XML, period (the consumer of those imports decides what the data represents). Reword.
1 parent 982e896 commit 18f7257

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

roles/icingaweb2_module_fileshipper/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Ansible Role linuxfabrik.lfops.icingaweb2_module_fileshipper
22

3-
This role installs and enables the [IcingaWeb2 Fileshipper Module](https://github.com/Icinga/icingaweb2-module-fileshipper). The Fileshipper extends the Icinga Director with the ability to import host / service definitions from CSV / YAML / JSON / XML files on disk and from plain config-file templates.
3+
This role installs and enables the [IcingaWeb2 Fileshipper Module](https://github.com/Icinga/icingaweb2-module-fileshipper). The Fileshipper extends the Icinga Director with two things: an `Import Source` that reads CSV / JSON / YAML / XML files from disk, and the ability to ship hand-crafted Icinga 2 config files through the Director.
44

55
This role is tested with the following IcingaWeb2 Fileshipper Module versions:
66

roles/icingaweb2_module_generictts/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Ansible Role linuxfabrik.lfops.icingaweb2_module_generictts
22

3-
This role installs and enables the [IcingaWeb2 GenericTTS Module](https://github.com/Icinga/icingaweb2-module-generictts), which renders ticket-system references found in Icinga `notes` / `notes_url` fields as clickable links into a configurable issue tracker (Jira, Redmine, Bugzilla, ...).
3+
This role installs and enables the [IcingaWeb2 GenericTTS Module](https://github.com/Icinga/icingaweb2-module-generictts). The module rewrites ticket patterns (configurable regular expressions) found in Icinga acknowledgements, downtimes and comments into clickable links pointing at the configured trouble-ticket system.
44

55
This role is tested with the following IcingaWeb2 GenericTTS Module versions:
66

0 commit comments

Comments
 (0)