Merge branch '300617-aqualls-prometheus-settings' into 'master'

Update settings UI text for Prometheus

See merge request gitlab-org/gitlab!53179

app/models/project_services/prometheus_service.rb

@@ -46,7 +46,7 @@ class PrometheusService < MonitoringService
   end
 
   def description
-    s_('PrometheusService|Time-series monitoring service')
+    s_('PrometheusService|Monitor application health with Prometheus metrics and dashboards')
   end
 
   def self.to_param
@@ -59,20 +59,23 @@ class PrometheusService < MonitoringService
         type: 'checkbox',
         name: 'manual_configuration',
         title: s_('PrometheusService|Active'),
+        help: s_('PrometheusService|Select this checkbox to override the auto configuration settings with your own settings.'),
         required: true
       },
       {
         type: 'text',
         name: 'api_url',
         title: 'API URL',
-        placeholder: s_('PrometheusService|Prometheus API Base URL, like http://prometheus.example.com/'),
+        placeholder: s_('PrometheusService|https://prometheus.example.com/'),
+        help: s_('PrometheusService|The Prometheus API base URL.'),
         required: true
       },
       {
         type: 'text',
         name: 'google_iap_audience_client_id',
         title: 'Google IAP Audience Client ID',
-        placeholder: s_('PrometheusService|Client ID of the IAP secured resource (looks like IAP_CLIENT_ID.apps.googleusercontent.com)'),
+        placeholder: s_('PrometheusService|IAP_CLIENT_ID.apps.googleusercontent.com'),
+        help: s_('PrometheusService|PrometheusService|The ID of the IAP-secured resource.'),
         autocomplete: 'off',
         required: false
       },
@@ -80,7 +83,8 @@ class PrometheusService < MonitoringService
         type: 'textarea',
         name: 'google_iap_service_account_json',
         title: 'Google IAP Service Account JSON',
-        placeholder: s_('PrometheusService|Contents of the credentials.json file of your service account, like: { "type": "service_account", "project_id": ... }'),
+        placeholder: s_('PrometheusService|{ "type": "service_account", "project_id": ... }'),
+        help: s_('PrometheusService|The contents of the credentials.json file of your service account.'),
         required: false
       }
     ]

app/views/projects/services/prometheus/_configuration_banner.html.haml

@@ -3,7 +3,7 @@
 
 - if service.manual_configuration?
   .info-well
-    = s_('PrometheusService|To enable the installation of Prometheus on your clusters, deactivate the manual configuration below')
+    = s_('PrometheusService|To enable the installation of Prometheus on your clusters, deactivate the manual configuration.')
 - else
   .container-fluid
     .row
@@ -13,14 +13,14 @@
             = image_tag 'illustrations/monitoring/getting_started.svg'
         .col-sm-10
           %p.text-success.gl-mt-3
-            = s_('PrometheusService|Prometheus is being automatically managed on your clusters')
+            = s_('PrometheusService|GitLab is managing Prometheus on your clusters.')
           = link_to s_('PrometheusService|Manage clusters'), project_clusters_path(project), class: 'btn gl-button'
       - else
         .col-sm-2
           = image_tag 'illustrations/monitoring/loading.svg'
         .col-sm-10
           %p.gl-mt-3
-            = s_('PrometheusService|Automatically deploy and configure Prometheus on your clusters to monitor your project’s environments')
+            = s_('PrometheusService|Automatically deploy and configure Prometheus on your clusters to monitor your project’s environments.')
           = link_to s_('PrometheusService|Install Prometheus on clusters'), project_clusters_path(project), class: 'btn gl-button btn-success'
 
 %hr

app/views/projects/services/prometheus/_help.html.haml

@@ -4,4 +4,4 @@
 %h4.gl-mb-3
   = s_('PrometheusService|Manual configuration')
 %p
-  = s_('PrometheusService|Select the Active checkbox to override the Auto Configuration with custom settings. If unchecked, Auto Configuration settings are used.')
+  = s_('PrometheusService|Auto configuration settings are used unless you override their values here.')

app/views/projects/settings/operations/_configuration_banner.html.haml

@@ -3,7 +3,7 @@
 
 - if service.manual_configuration?
   .info-well.p-2.mt-2
-    = s_('PrometheusService|To enable the installation of Prometheus on your clusters, deactivate the manual configuration below')
+    = s_('PrometheusService|To enable the installation of Prometheus on your clusters, deactivate the manual configuration.')
 - else
   .container-fluid
     .row
@@ -13,12 +13,12 @@
             = image_tag 'illustrations/monitoring/getting_started.svg'
         .col-sm-10
           %p.text-success.gl-mt-3
-            = s_('PrometheusService|Prometheus is being automatically managed on your clusters')
+            = s_('PrometheusService|GitLab manages Prometheus on your clusters.')
           = link_to s_('PrometheusService|Manage clusters'), project_clusters_path(project), class: 'btn'
       - else
         .col-sm-2
           = image_tag 'illustrations/monitoring/loading.svg'
         .col-sm-10
           %p.gl-mt-3
-            = s_('PrometheusService|Automatically deploy and configure Prometheus on your clusters to monitor your project’s environments')
+            = s_('PrometheusService|Monitor your project’s environments by deploying and configuring Prometheus on your clusters.')
           = link_to s_('PrometheusService|Install Prometheus on clusters'), project_clusters_path(project), class: 'btn btn-success'

app/views/projects/settings/operations/_prometheus.html.haml

@@ -14,4 +14,4 @@
     %b.gl-mb-3
       = s_('PrometheusService|Manual configuration')
     %p
-      = s_('PrometheusService|Select the Active checkbox to override the Auto Configuration with custom settings. If unchecked, Auto Configuration settings are used.')
+      = s_('PrometheusService|Auto configuration settings are used unless you override their values here.')

changelogs/unreleased/300617-aqualls-prometheus-settings.yml

+---
+title: Updated UI text to match style guidelines
+merge_request: 53179
+author:
+type: other

lib/api/helpers/services_helpers.rb

@@ -635,7 +635,7 @@ module API
               required: true,
               name: :google_iap_audience_client_id,
               type: String,
-              desc: 'Client ID of the IAP secured resource (looks like IAP_CLIENT_ID.apps.googleusercontent.com)'
+              desc: 'Client ID of the IAP-secured resource (looks like IAP_CLIENT_ID.apps.googleusercontent.com)'
             },
             {
               required: true,

locale/gitlab.pot

@@ -23977,10 +23977,10 @@ msgstr ""
 msgid "PrometheusService|Auto configuration"
 msgstr ""
 
-msgid "PrometheusService|Automatically deploy and configure Prometheus on your clusters to monitor your project’s environments"
+msgid "PrometheusService|Auto configuration settings are used unless you override their values here."
 msgstr ""
 
-msgid "PrometheusService|Client ID of the IAP secured resource (looks like IAP_CLIENT_ID.apps.googleusercontent.com)"
+msgid "PrometheusService|Automatically deploy and configure Prometheus on your clusters to monitor your project’s environments."
 msgstr ""
 
 msgid "PrometheusService|Common metrics"
@@ -23989,9 +23989,6 @@ msgstr ""
 msgid "PrometheusService|Common metrics are automatically monitored based on a library of metrics from popular exporters."
 msgstr ""
 
-msgid "PrometheusService|Contents of the credentials.json file of your service account, like: { \"type\": \"service_account\", \"project_id\": ... }"
-msgstr ""
-
 msgid "PrometheusService|Custom metrics"
 msgstr ""
 
@@ -24007,6 +24004,15 @@ msgstr ""
 msgid "PrometheusService|Finding custom metrics..."
 msgstr ""
 
+msgid "PrometheusService|GitLab is managing Prometheus on your clusters."
+msgstr ""
+
+msgid "PrometheusService|GitLab manages Prometheus on your clusters."
+msgstr ""
+
+msgid "PrometheusService|IAP_CLIENT_ID.apps.googleusercontent.com"
+msgstr ""
+
 msgid "PrometheusService|Install Prometheus on clusters"
 msgstr ""
 
@@ -24022,6 +24028,12 @@ msgstr ""
 msgid "PrometheusService|Missing environment variable"
 msgstr ""
 
+msgid "PrometheusService|Monitor application health with Prometheus metrics and dashboards"
+msgstr ""
+
+msgid "PrometheusService|Monitor your project’s environments by deploying and configuring Prometheus on your clusters."
+msgstr ""
+
 msgid "PrometheusService|More information"
 msgstr ""
 
@@ -24034,22 +24046,22 @@ msgstr ""
 msgid "PrometheusService|No custom metrics have been created. Create one using the button above"
 msgstr ""
 
-msgid "PrometheusService|Prometheus API Base URL, like http://prometheus.example.com/"
+msgid "PrometheusService|PrometheusService|The ID of the IAP-secured resource."
 msgstr ""
 
-msgid "PrometheusService|Prometheus is being automatically managed on your clusters"
+msgid "PrometheusService|Select this checkbox to override the auto configuration settings with your own settings."
 msgstr ""
 
-msgid "PrometheusService|Select the Active checkbox to override the Auto Configuration with custom settings. If unchecked, Auto Configuration settings are used."
+msgid "PrometheusService|The Prometheus API base URL."
 msgstr ""
 
-msgid "PrometheusService|These metrics will only be monitored after your first deployment to an environment"
+msgid "PrometheusService|The contents of the credentials.json file of your service account."
 msgstr ""
 
-msgid "PrometheusService|Time-series monitoring service"
+msgid "PrometheusService|These metrics will only be monitored after your first deployment to an environment"
 msgstr ""
 
-msgid "PrometheusService|To enable the installation of Prometheus on your clusters, deactivate the manual configuration below"
+msgid "PrometheusService|To enable the installation of Prometheus on your clusters, deactivate the manual configuration."
 msgstr ""
 
 msgid "PrometheusService|Waiting for your first deployment to an environment to find common metrics"
@@ -24058,6 +24070,12 @@ msgstr ""
 msgid "PrometheusService|You can now manage your Prometheus settings on the %{operations_link_start}Operations%{operations_link_end} page. Fields on this page has been deprecated."
 msgstr ""
 
+msgid "PrometheusService|https://prometheus.example.com/"
+msgstr ""
+
+msgid "PrometheusService|{ \"type\": \"service_account\", \"project_id\": ... }"
+msgstr ""
+
 msgid "Promote"
 msgstr ""
 

spec/models/project_services/prometheus_service_spec.rb

@@ -511,20 +511,23 @@ RSpec.describe PrometheusService, :use_clean_rails_memory_store_caching, :snowpl
           type: 'checkbox',
           name: 'manual_configuration',
           title: s_('PrometheusService|Active'),
+          help: s_('PrometheusService|Select this checkbox to override the auto configuration settings with your own settings.'),
           required: true
         },
         {
           type: 'text',
           name: 'api_url',
           title: 'API URL',
-          placeholder: s_('PrometheusService|Prometheus API Base URL, like http://prometheus.example.com/'),
+          placeholder: s_('PrometheusService|https://prometheus.example.com/'),
+          help: s_('PrometheusService|The Prometheus API base URL.'),
           required: true
         },
         {
           type: 'text',
           name: 'google_iap_audience_client_id',
           title: 'Google IAP Audience Client ID',
-          placeholder: s_('PrometheusService|Client ID of the IAP secured resource (looks like IAP_CLIENT_ID.apps.googleusercontent.com)'),
+          placeholder: s_('PrometheusService|IAP_CLIENT_ID.apps.googleusercontent.com'),
+          help: s_('PrometheusService|PrometheusService|The ID of the IAP-secured resource.'),
           autocomplete: 'off',
           required: false
         },
@@ -532,7 +535,8 @@ RSpec.describe PrometheusService, :use_clean_rails_memory_store_caching, :snowpl
           type: 'textarea',
           name: 'google_iap_service_account_json',
           title: 'Google IAP Service Account JSON',
-          placeholder: s_('PrometheusService|Contents of the credentials.json file of your service account, like: { "type": "service_account", "project_id": ... }'),
+          placeholder: s_('PrometheusService|{ "type": "service_account", "project_id": ... }'),
+          help: s_('PrometheusService|The contents of the credentials.json file of your service account.'),
           required: false
         }
       ]

spec/views/projects/settings/operations/show.html.haml_spec.rb

@@ -59,7 +59,7 @@ RSpec.describe 'projects/settings/operations/show' do
 
         expect(rendered).to have_content _('Prometheus')
         expect(rendered).to have_content _('Link Prometheus monitoring to GitLab.')
-        expect(rendered).to have_content _('To enable the installation of Prometheus on your clusters, deactivate the manual configuration below')
+        expect(rendered).to have_content _('To enable the installation of Prometheus on your clusters, deactivate the manual configuration.')
       end
     end
 
@@ -71,7 +71,7 @@ RSpec.describe 'projects/settings/operations/show' do
       it 'renders the Operations Settings page' do
         render
 
-        expect(rendered).not_to have_content _('Select the Active checkbox to override the Auto Configuration with custom settings. If unchecked, Auto Configuration settings are used.')
+        expect(rendered).not_to have_content _('Auto configuration settings are used unless you override their values here.')
       end
     end
   end