Change JIRA to Jira

Author: raviks789

README.md

@@ -1,4 +1,4 @@
-# Icinga Module for JIRA®
+# Icinga Module for Jira®
 
 [![PHP Support](https://img.shields.io/badge/php-%3E%3D%207.0-777BB4?logo=PHP)](https://php.net/)
 ![Build Status](https://github.com/icinga/icingaweb2-module-jira/workflows/PHP%20Tests/badge.svg?branch=master)
@@ -9,21 +9,21 @@
 Hassle-free deep integration with Atlassian Jira®. Depending on your needs, this
 module is able to:
 
-* create **JIRA Issues for Problems** detected by Icinga
+* create **Jira Issues for Problems** detected by Icinga
 * create **only one** issue per problem
-* **acknowledge** Icinga Problems once a JIRA issue has been created
-* manually create Host- or Service-related JIRA issues
-* shows a Host/Service-related **JIRA Issue History**
+* **acknowledge** Icinga Problems once a Jira issue has been created
+* manually create Host- or Service-related Jira issues
+* shows a Host/Service-related **Jira Issue History**
 
-And there is more. Use custom templates to trigger JIRA **Workflows** according
-your very own needs. This way you can automatically fill JIRA custom fields
+And there is more. Use custom templates to trigger Jira **Workflows** according
+your very own needs. This way you can automatically fill Jira custom fields
 based on monitored system properties. This feature is mostly being used to
 assign monitored objects to their **related CIs** or to trigger dedicated
 **customer-related workflows**.
 
 This is 100% free Open Source Software. Interested? Then let's [get started](doc/01-Introduction.md)!
 
-![JIRA integration](doc/screenshot/issue_list_and_details-new.png)
+![Jira integration](doc/screenshot/issue_list_and_details-new.png)
 
 Changes
 -------
@@ -35,7 +35,7 @@ Changes
 
 ### v1.2.1
 
-* FIX: Creating tickets in JIRA now works again (#77)
+* FIX: Creating tickets in Jira now works again (#77)
 
 ### v1.2.0
 
@@ -52,11 +52,11 @@ Changes
 * FIX: we're sending Content-Length to make proxies happy (#51)
 * FEATURE: Show status for created issues (#44)
 * FEATURE: Allow choosing a default template (#36)
-* FEATURE: Add configurable duedate for created JIRA issues (#37)
+* FEATURE: Add configurable duedate for created Jira issues (#37)
 
 ### v1.0.1
 
-* FIX: Ticket URLs pointing to JIRA for Setups sitting in the DocumentRoot (#30)
+* FIX: Ticket URLs pointing to Jira for Setups sitting in the DocumentRoot (#30)
 * FIX: The new HTTP/HTTPS scheme setting didn't work (#30)
 * FIX: There still was a dependency on Icinga Director (#28)
 * FIX: Form for manually created issues didn't work without Icinga Director (#27)

application/clicommands/SendCommand.php

@@ -27,10 +27,10 @@ class SendCommand extends Command
      *
      * REQUIRED OPTIONS
      *
-     *   --project <project-name>     JIRA project name, like "ITSM"
-     *   --issuetype <type-name>      JIRA issue type, like "Incident"
-     *   --summary <summary>          JIRA issue summary
-     *   --description <description>  JIRA issue description text
+     *   --project <project-name>     Jira project name, like "ITSM"
+     *   --issuetype <type-name>      Jira issue type, like "Incident"
+     *   --summary <summary>          Jira issue summary
+     *   --description <description>  Jira issue description text
      *   --state <state-name>         Icinga state
      *   --host <host-name>           Icinga Host name
      *
@@ -41,7 +41,7 @@ class SendCommand extends Command
      *                              It can be a date  or time difference in textual datetime format.
      *   --template <template-name> Template name (templates.ini section)
      *   --ack-author <author>      Username shown for acknowledgements,
-     *                              defaults to "JIRA"
+     *                              defaults to "Jira"
      *   --no-acknowledge           Do not acknowledge Icinga problem
      *   --command-pipe <path>      Legacy command pipe, allows to run without
      *                              depending on a configured monitoring module
@@ -60,7 +60,7 @@ public function problemAction()
         $host        = $p->shiftRequired('host');
         $service     = $p->shift('service');
         $tplName     = $p->shift('template');
-        $ackAuthor   = $p->shift('ack-author', 'JIRA');
+        $ackAuthor   = $p->shift('ack-author', 'Jira');
         $ackPipe     = $p->shift('command-pipe');
         $status      = $p->shiftRequired('state');
         $description = $p->shiftRequired('description');
@@ -116,12 +116,12 @@ public function problemAction()
 
             $key = $jira->createIssue($template->getFilled($params));
 
-            $ackMessage = "JIRA issue $key has been created";
+            $ackMessage = "Jira issue $key has been created";
         } else {
             $key = $issue->key;
             $icingaStatus = $config->get('key_fields', 'icingaStatus', 'icingaStatus');
             $currentStatus = isset($issue->fields->$icingaStatus) ? $issue->fields->$icingaStatus : null;
-            $ackMessage = "Existing JIRA issue $key has been found";
+            $ackMessage = "Existing Jira issue $key has been found";
             if ($currentStatus !== $status) {
                 $update = new IssueUpdate($jira, $key);
                 $update->setCustomField($icingaStatus, $status);

application/controllers/IssuesController.php

@@ -53,7 +53,7 @@ protected function showNewIssueForm()
     {
         $info = $this->requireMonitoringInfo();
         $info->setNotificationType('MANUAL'); // Not sure about this, but that's how it used to be
-        $this->addTitle($this->translate('Create JIRA Issue') . ': %s', $info->getObjectLabel())
+        $this->addTitle($this->translate('Create Jira Issue') . ': %s', $info->getObjectLabel())
             ->activateTab();
 
         $form = (new NewIssueForm($this->jira(), $this->getModuleConfig(), $info))

application/forms/Config/ConfigForm.php

@@ -1,6 +1,6 @@
 <?php
 
-// Icinga Web JIRA Integration | (c) 2023 Icinga GmbH | GPLv2
+// Icinga Web Jira Integration | (c) 2023 Icinga GmbH | GPLv2
 
 namespace Icinga\Module\Jira\Forms\Config;
 

doc/01-Introduction.md

@@ -1,15 +1,15 @@
 Introduction
 ============
 
-This module allows to send notifications to JIRA and integrates nicely into the
+This module allows to send notifications to Jira and integrates nicely into the
 Icinga Web 2 frontend.
 
 Features
 --------
 
 ### NotificationCommand for Icinga
 
-You want to create a JIRA issue for all or some of your Hosts and Services?
+You want to create a Jira issue for all or some of your Hosts and Services?
 Then this project might be what you're looking for. Sending notifications is
 as easy as follows:
 
@@ -36,7 +36,7 @@ this works.
 ### Brief issue history overview
 
 Granted access to this module you can get a quick overview showing the most recent
-JIRA issues created by Icinga. Read more about [what information](20-Issue-History.md)
+Jira issues created by Icinga. Read more about [what information](20-Issue-History.md)
 we're going to show.
 
 ![Issue list and details](screenshot/issue_list_and_details_small.png)

doc/03-Configuration.md

@@ -9,7 +9,7 @@
 * Icinga Web 2 modules:
   * The `monitoring` or `icingadb` module needs to be configured and enabled.
 
-## Install the Icinga Module for JIRA®
+## Install the Icinga Module for Jira®
 
 Install it [like any other module](https://icinga.com/docs/icinga-web-2/latest/doc/08-Modules/#installation).
 Use `jira` as name.
@@ -49,11 +49,11 @@ url = "https://icinga.example.com/icingaweb2"
 ```
 
 The `port` and `path` settings are optional, protocol is always HTTPS. The
-given user needs permissions to create (and show) issues in at least one JIRA
+given user needs permissions to create (and show) issues in at least one Jira
 project.
 
 If you want to have links pointing back to your Icinga Installation in your
-JIRA issues, you need to fill the `url` setting.
+Jira issues, you need to fill the `url` setting.
 
 The `ui` section allows to optionally pre-select a specific project and/or a
 specific issue type in the "Create New Issue" form. Please note that those
@@ -71,9 +71,9 @@ afterwards:
 
     systemctl restart icinga2.service
 
-### Required JIRA Custom Fields
+### Required Jira Custom Fields
 
-This module requires you to create two custom fields in JIRA:
+This module requires you to create two custom fields in Jira:
 
 * `icingaKey`: a searchable text field
 * `icingaStatus`: a short text field, 12 characters are enough
@@ -85,7 +85,7 @@ this field is going to be used.
 
 This module uses `icingaKey` to figure out whether an issue for the given object
 already exists. Hosts use their host name, services use hostname!servicename.
-As JIRA seems to offer no exact search for custom text fields out of the box (at
+As Jira seems to offer no exact search for custom text fields out of the box (at
 least not without installing extra plugins), we are cheating. Search is down via
 `~` and we add surrounding escaped double quotes. Still, this doesn't seem to be
 enough. So we prefix the key with `BEGIN` and postfix it with `END`.
@@ -98,7 +98,7 @@ following JQL construct:
 A little bit weird, but it should work fine. And as this field is usually not
 shown anywhere, it shouldn't disturb.
 
-### Fill JIRA Custom Fields
+### Fill Jira Custom Fields
 
 > **Hint**: This is optional, do not blindly copy & paste. Use this as an
 > example in case you need to feed different workflows with special paprameters.

doc/10-Notifications.md

@@ -1,7 +1,7 @@
 Sending Notifications
 =====================
 
-This is what your monitoring software should call to send a notification to JIRA:
+This is what your monitoring software should call to send a notification to Jira:
 
     icingacli jira send problem \
         --host some.example.com \
@@ -26,10 +26,10 @@ icingacli jira send problem [options]
 
 REQUIRED OPTIONS
 
-  --project <project-name>     JIRA project name, like "ITSM"
-  --issuetype <type-name>      JIRA issue type, like "Incident"
-  --summary <summary>          JIRA issue summary
-  --description <description>  JIRA issue description text
+  --project <project-name>     Jira project name, like "ITSM"
+  --issuetype <type-name>      Jira issue type, like "Incident"
+  --summary <summary>          Jira issue summary
+  --description <description>  Jira issue description text
   --state <state-name>         Icinga state
   --host <host-name>           Icinga Host name
 
@@ -38,7 +38,7 @@ OPTIONAL
   --service <service-name>   Icinga Service name
   --template <template-name> Template name (templates.ini section)
   --ack-author <author>      Username shown for acknowledgements,
-                             defaults to "JIRA"
+                             defaults to "Jira"
   --no-acknowledge           Do not acknowledge Icinga problem
   --command-pipe <path>      Legacy command pipe, allows to run without
                              depending on a configured monitoring module
@@ -55,35 +55,35 @@ Icinga 2 NotificationCommand
 In Icinga 2, a related `NotificationCommand` definition could look as follows:
 
 ```
-object NotificationCommand "JIRA Host Notification" {
+object NotificationCommand "Jira Host Notification" {
     import "plugin-notification-command"
     command = [ "/usr/bin/icingacli", "jira", "send", "problem" ]
     arguments += {
         "--ack-author" = {
-            description = "This author name will be used when acknowledging Icinga problems once a JIRA issue got created"
+            description = "This author name will be used when acknowledging Icinga problems once a Jira issue got created"
             value = "$jira_ack_author$"
         }
         "--command-pipe" = {
             description = "Legacy Icinga command pipe. Should only be used on Icinga 1.x system without a correctly configured Icinga Web 2 monitoring module"
             value = "$jira_command_pipe$"
         }
         "--description" = {
-            description = "JIRA issue description"
+            description = "Jira issue description"
             required = true
             value = "$jira_description$"
         }
         "--host" = "$host.name$"
         "--issuetype" = {
-            description = "JIRA issue type (e.g. Incident)"
+            description = "Jira issue type (e.g. Incident)"
             required = true
             value = "$jira_issuetype$"
         }
         "--no-acknowledge" = {
-            description = "D not acknowledge  Icinga problems once a JIRA issue got created"
+            description = "D not acknowledge  Icinga problems once a Jira issue got created"
             value = "$jira_no_acknowledge$"
         }
         "--project" = {
-            description = "JIRA project name (e.g. ITSM)"
+            description = "Jira project name (e.g. ITSM)"
             required = true
             value = "$jira_project$"
         }
@@ -92,12 +92,12 @@ object NotificationCommand "JIRA Host Notification" {
             value = "$host.state$"
         }
         "--summary" = {
-            description = "JIRA issue summary"
+            description = "Jira issue summary"
             required = true
             value = "$jira_summary$"
         }
         "--template" = {
-            description = "Issue template name (templates.ini section). This allows to pass custom fields to JIRA"
+            description = "Issue template name (templates.ini section). This allows to pass custom fields to Jira"
             value = "$jira_template$"
         }
     }
@@ -110,35 +110,35 @@ Host- and Service-NotificationCommands need distinct command definitions, so her
 is what it would look like for a Service:
 
 ```
-object NotificationCommand "JIRA Service Notification" {
+object NotificationCommand "Jira Service Notification" {
     import "plugin-notification-command"
     command = [ "/usr/bin/icingacli", "jira", "send", "problem" ]
     arguments += {
         "--ack-author" = {
-            description = "This author name will be used when acknowledging Icinga problems once a JIRA issue got created"
+            description = "This author name will be used when acknowledging Icinga problems once a Jira issue got created"
             value = "$jira_ack_author$"
         }
         "--command-pipe" = {
             description = "Legacy Icinga command pipe. Should only be used on Icinga 1.x system without a correctly configured Icinga Web 2 monitoring module"
             value = "$jira_command_pipe$"
         }
         "--description" = {
-            description = "JIRA issue description"
+            description = "Jira issue description"
             required = true
             value = "$jira_description$"
         }
         "--host" = "$host.name$"
         "--issuetype" = {
-            description = "JIRA issue type (e.g. Incident)"
+            description = "Jira issue type (e.g. Incident)"
             required = true
             value = "$jira_issuetype$"
         }
         "--no-acknowledge" = {
-            description = "D not acknowledge  Icinga problems once a JIRA issue got created"
+            description = "D not acknowledge  Icinga problems once a Jira issue got created"
             value = "$jira_no_acknowledge$"
         }
         "--project" = {
-            description = "JIRA project name (e.g. ITSM)"
+            description = "Jira project name (e.g. ITSM)"
             required = true
             value = "$jira_project$"
         }
@@ -148,12 +148,12 @@ object NotificationCommand "JIRA Service Notification" {
             value = "$service.state$"
         }
         "--summary" = {
-            description = "JIRA issue summary"
+            description = "Jira issue summary"
             required = true
             value = "$jira_summary$"
         }
         "--template" = {
-            description = "Issue template name (templates.ini section). This allows to pass custom fields to JIRA"
+            description = "Issue template name (templates.ini section). This allows to pass custom fields to Jira"
             value = "$jira_template$"
         }
     }

doc/20-Issue-History.md

@@ -1,9 +1,9 @@
 Issue History and Details
 =========================
 
-For convenience, this module comes with a nice overview of your created JIRA
+For convenience, this module comes with a nice overview of your created Jira
 issues. It shows your most recent issues, combined with the most important
-details. Please note that only issues created by the configured JIRA user will
+details. Please note that only issues created by the configured Jira user will
 be shown.
 
 Issue History Table
@@ -19,14 +19,14 @@ The Summary column shows issue summary and description, and the last column
 shows how long ago the issue has been created. Move the mouse over the shown
 time to read the full related creation time with timezone details.
 
-![JIRA issue list](screenshot/issue_list.png)
+![Jira issue list](screenshot/issue_list.png)
 
 You can then choose an issue, and you'll provided with some more details. All
 comments posted to this issue will be shown. Also, there are and some links
-pointing to JIRA (directly to the issue or to it's project) and to the related
+pointing to Jira (directly to the issue or to it's project) and to the related
 Icinga Host or Service.
 
-![JIRA issue details](screenshot/issue_details.png)
+![Jira issue details](screenshot/issue_details.png)
 
 
 Monitoring module hook