Adds missing report documentations (#16878)

* Fix report documentation not shown when switching between related reports

* Adds report documentation for DevicesDetection reports

* Adds some more report documentations

* Adds documentation to Event reports

* Adds documentation to Content reports

* Adds documentation to VisitorFrequency report

* Adds documentation to Goals reports

* Adds documentation to VisitsSummary report

* fixes & test updates

* fix typo

Co-authored-by: Lukas Winkler <git@lw1.at>

* small tweaks to some docs

* revising some of the report documentation

* fix translation file

* updates expected test files

Co-authored-by: Lukas Winkler <git@lw1.at>
Co-authored-by: diosmosis <diosmosis@users.noreply.github.com>

8 files changed, 14 insertions, 8 deletions

diff --git a/plugins/DevicesDetection/Reports/GetBrand.php b/plugins/DevicesDetection/Reports/GetBrand.php
index 7fc5a20066..c01a9e2afb 100644
--- a/plugins/DevicesDetection/Reports/GetBrand.php
+++ b/plugins/DevicesDetection/Reports/GetBrand.php
@@ -19,7 +19,7 @@ class GetBrand extends Base
         parent::init();
         $this->dimension     = new DeviceBrand();
         $this->name          = Piwik::translate('DevicesDetection_DeviceBrand');
-        $this->documentation = ''; // TODO
+        $this->documentation = Piwik::translate('DevicesDetection_DeviceBrandReportDocumentation');
         $this->order = 4;
         $this->hasGoalMetrics = true;
         $this->subcategoryId = 'DevicesDetection_Devices';
diff --git a/plugins/DevicesDetection/Reports/GetBrowserVersions.php b/plugins/DevicesDetection/Reports/GetBrowserVersions.php
index 4be7c15705..bcfc0b799c 100644
--- a/plugins/DevicesDetection/Reports/GetBrowserVersions.php
+++ b/plugins/DevicesDetection/Reports/GetBrowserVersions.php
@@ -20,7 +20,7 @@ class GetBrowserVersions extends Base
         parent::init();
         $this->dimension     = new BrowserVersion();
         $this->name          = Piwik::translate('DevicesDetection_BrowserVersion');
-        $this->documentation = ''; // TODO
+        $this->documentation = Piwik::translate('DevicesDetection_WidgetBrowserVersionsDocumentation');
         $this->order = 6;
         $this->subcategoryId = 'DevicesDetection_Software';
     }
diff --git a/plugins/DevicesDetection/Reports/GetBrowsers.php b/plugins/DevicesDetection/Reports/GetBrowsers.php
index 4b0b35fec9..1b511a8be1 100644
--- a/plugins/DevicesDetection/Reports/GetBrowsers.php
+++ b/plugins/DevicesDetection/Reports/GetBrowsers.php
@@ -20,7 +20,7 @@ class GetBrowsers extends Base
         parent::init();
         $this->dimension     = new BrowserName();
         $this->name          = Piwik::translate('DevicesDetection_Browsers');
-        $this->documentation = Piwik::translate('DevicesDetection_WidgetBrowsersDocumentation', '<br />');
+        $this->documentation = Piwik::translate('DevicesDetection_WidgetBrowsersDocumentation');
         $this->order = 5;
         $this->subcategoryId = 'DevicesDetection_Software';
         $this->hasGoalMetrics = true;
diff --git a/plugins/DevicesDetection/Reports/GetModel.php b/plugins/DevicesDetection/Reports/GetModel.php
index 6fb6682ee2..cf79fd8caa 100644
--- a/plugins/DevicesDetection/Reports/GetModel.php
+++ b/plugins/DevicesDetection/Reports/GetModel.php
@@ -19,7 +19,7 @@ class GetModel extends Base
         parent::init();
         $this->dimension     = new DeviceModel();
         $this->name          = Piwik::translate('DevicesDetection_DeviceModel');
-        $this->documentation = ''; // TODO
+        $this->documentation = Piwik::translate('DevicesDetection_DeviceModelReportDocumentation');
         $this->order = 2;
         $this->hasGoalMetrics = true;
         $this->subcategoryId = 'DevicesDetection_Devices';
diff --git a/plugins/DevicesDetection/Reports/GetOsFamilies.php b/plugins/DevicesDetection/Reports/GetOsFamilies.php
index 0ac56d7250..1efe491621 100644
--- a/plugins/DevicesDetection/Reports/GetOsFamilies.php
+++ b/plugins/DevicesDetection/Reports/GetOsFamilies.php
@@ -20,7 +20,7 @@ class GetOsFamilies extends Base
         parent::init();
         $this->dimension     = new Os();
         $this->name          = Piwik::translate('DevicesDetection_OperatingSystemFamilies');
-        $this->documentation = ''; // TODO
+        $this->documentation = Piwik::translate('DevicesDetection_OperatingSystemFamiliesReportDocumentation');
         $this->order = 8;
 
         $this->subcategoryId = 'DevicesDetection_Software';
diff --git a/plugins/DevicesDetection/Reports/GetOsVersions.php b/plugins/DevicesDetection/Reports/GetOsVersions.php
index 8dcc2f5fab..39f7625d05 100644
--- a/plugins/DevicesDetection/Reports/GetOsVersions.php
+++ b/plugins/DevicesDetection/Reports/GetOsVersions.php
@@ -20,7 +20,7 @@ class GetOsVersions extends Base
         parent::init();
         $this->dimension     = new OsVersion();
         $this->name          = Piwik::translate('DevicesDetection_OperatingSystemVersions');
-        $this->documentation = ''; // TODO
+        $this->documentation = Piwik::translate('DevicesDetection_OperatingSystemVersionsReportDocumentation');
         $this->order = 2;
 
         $this->subcategoryId = 'DevicesDetection_Software';
diff --git a/plugins/DevicesDetection/Reports/GetType.php b/plugins/DevicesDetection/Reports/GetType.php
index 22fe00de34..6ebb6b4b11 100644
--- a/plugins/DevicesDetection/Reports/GetType.php
+++ b/plugins/DevicesDetection/Reports/GetType.php
@@ -20,7 +20,7 @@ class GetType extends Base
         parent::init();
         $this->dimension     = new DeviceType();
         $this->name          = Piwik::translate('DevicesDetection_DeviceType');
-        $this->documentation = ''; // TODO
+        $this->documentation = Piwik::translate('DevicesDetection_DeviceTypeReportDocumentation');
         $this->order = 0;
         $this->hasGoalMetrics = true;
         $this->subcategoryId = 'DevicesDetection_Devices';
diff --git a/plugins/DevicesDetection/lang/en.json b/plugins/DevicesDetection/lang/en.json
index 934c11a1fe..0f3bab1421 100644
--- a/plugins/DevicesDetection/lang/en.json
+++ b/plugins/DevicesDetection/lang/en.json
@@ -25,18 +25,23 @@
         "Device": "Device",
         "DeviceBrand": "Device brand",
         "DeviceBrands": "Device brands",
+        "DeviceBrandReportDocumentation": "This report shows the brands / manufacturers of the devices your visitors were using. In most cases this information is only available for non-desktop devices.",
         "DeviceDetection": "Device detection",
         "DeviceModel": "Device model",
         "DeviceModels": "Device models",
+        "DeviceModelReportDocumentation": "This report shows the devices your visitors are using. Each model is displayed combined with the device brand as some model names are used by multiple brands.",
         "DevicesDetection": "Visitor Devices",
         "DeviceType": "Device type",
         "DeviceTypes": "Device types",
+        "DeviceTypeReportDocumentation": "This report shows the types of devices your visitors were using. This report will always show all device types Matomo is able to detect, even if there were no visits with a specific type.",
         "FeaturePhone": "Feature phone",
         "OperatingSystemFamilies": "Operating System families",
         "OperatingSystemFamily": "Operating system family",
+        "OperatingSystemFamiliesReportDocumentation": "This report shows you the operating systems your visitors are using grouped by operating system family. An operating system family consists of different versions or distributions.",
         "OperatingSystemCode": "Operating system code",
         "OperatingSystems": "Operating systems",
         "OperatingSystemVersions": "Operating System versions",
+        "OperatingSystemVersionsReportDocumentation": "This report shows you the operating systems your visitors are using. Each version and distribution is shown separately.",
         "PluginDescription": "Provides extended information about user devices, such as Brand (manufacturer), Model (device version), device type (tv, consoles, smart phones, desktop, etc) and more.",
         "SmartDisplay": "Smart display",
         "Smartphone": "Smartphone",
@@ -58,6 +63,7 @@
         "XVisitsFromDevices": "%1$s visits from %2$s devices",
         "Wearable": "Wearable",
         "WidgetBrowsers": "Visitor Browser",
-        "WidgetBrowsersDocumentation": "This report contains information about what kind of browser your visitors were using. Each browser version is listed separately."
+        "WidgetBrowsersDocumentation": "This report contains information about what kind of browser your visitors were using.",
+        "WidgetBrowserVersionsDocumentation": "This report contains information about what kind of browser your visitors were using. Each browser version is listed separately."
     }
 }
\ No newline at end of file