Merge branch 'eread/refactor-jaeger-tracing-configuration-ui' into 'master'

Refactor docs and UI for Jaeger tracing

See merge request gitlab-org/gitlab!56819

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

@@ -17,17 +17,18 @@
         - tracing_link = link_to project_tracing_path(@project) do
           %span
             = _('Tracing')
-      = _("To open Jaeger and easily view tracing from GitLab, link the %{link} page to your server").html_safe % { link: tracing_link }
+      = _("To open Jaeger from GitLab to view tracing from the %{link} page, add a URL to your Jaeger server.").html_safe % { link: tracing_link }
+      = link_to _('Learn more.'), help_page_path('operations/tracing'), target: '_blank', rel: 'noopener noreferrer'
   .settings-content
     = form_for @project, url: project_settings_operations_path(@project), method: :patch do |f|
       = form_errors(@project)
       .form-group
         = f.fields_for :tracing_setting_attributes, setting do |form|
           = form.label :external_url, _('Jaeger URL'), class: 'label-bold'
-          = form.url_field :external_url, class: 'form-control gl-form-input', placeholder: 'e.g. https://jaeger.mycompany.com'
+          = form.url_field :external_url, class: 'form-control gl-form-input', placeholder: 'https://jaeger.example.com'
           %p.form-text.text-muted
-            - jaeger_help_url = "https://www.jaegertracing.io/docs/1.7/getting-started/"
+            - jaeger_help_url = "https://www.jaegertracing.io/docs/getting-started/"
             - link_start_tag = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: jaeger_help_url }
             - link_end_tag = "#{sprite_icon('external-link', css_class: 'ml-1 vertical-align-middle')}</a>".html_safe
-            = _("For more information, please review %{link_start_tag}Jaeger's configuration doc%{link_end_tag}").html_safe % { link_start_tag: link_start_tag, link_end_tag: link_end_tag }
+            = _("Learn more about %{link_start_tag}Jaeger configuration%{link_end_tag}.").html_safe % { link_start_tag: link_start_tag, link_end_tag: link_end_tag }
       = f.submit _('Save changes'), class: 'gl-button btn btn-confirm'

app/views/projects/tracings/show.html.haml

@@ -24,10 +24,10 @@
       .text-content
         %h4.text-left= _('Troubleshoot and monitor your application with tracing')
         %p
-          - jaeger_help_url = "https://www.jaegertracing.io/docs/1.7/getting-started/"
+          - jaeger_help_url = "https://www.jaegertracing.io/docs/getting-started/"
           - link_start_tag = '<a href="%{url}" target="_blank" rel="noopener noreferrer">'.html_safe % { url: jaeger_help_url }
           - link_end_tag = "#{sprite_icon('external-link', css_class: 'ml-1 vertical-align-middle')}</a>".html_safe
-          = _('To get started, link this page to your Jaeger server, or find out how to %{link_start_tag}install Jaeger%{link_end_tag}').html_safe % { link_start_tag: link_start_tag, link_end_tag: link_end_tag }
+          = _('Add a Jaeger URL to replace this page with a link to your Jaeger server. You first need to %{link_start_tag}install Jaeger%{link_end_tag}.').html_safe % { link_start_tag: link_start_tag, link_end_tag: link_end_tag }
 
           .text-center
             = render 'tracing_button'

changelogs/unreleased/eread-refactor-jaeger-tracing-configuration-ui.yml

+---
+title: Refactor docs and UI for Jaeger tracing
+merge_request: 56819
+author:
+type: other

doc/operations/tracing.md

@@ -9,27 +9,26 @@ info: To determine the technical writer assigned to the Stage/Group associated w
 > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/7903) in GitLab Ultimate 11.5.
 > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/42645) to GitLab Free in 13.5.
 
-Tracing provides insight into the performance and health of a deployed application,
-tracking each function or microservice which handles a given request.
+Tracing provides insight into the performance and health of a deployed application, tracking each
+function or microservice that handles a given request. Tracing makes it easy to understand the
+end-to-end flow of a request, regardless of whether you are using a monolithic or distributed
+system.
 
-This makes it easy to
-understand the end-to-end flow of a request, regardless of whether you are using a monolithic or distributed system.
+## Install Jaeger
 
-## Jaeger tracing
-
-[Jaeger](https://www.jaegertracing.io/) is an open source, end-to-end distributed
-tracing system used for monitoring and troubleshooting microservices-based distributed
-systems.
+[Jaeger](https://www.jaegertracing.io/) is an open source, end-to-end distributed tracing system
+used for monitoring and troubleshooting microservices-based distributed systems. To learn more about
+installing Jaeger, read the official
+[Getting Started documentation](https://www.jaegertracing.io/docs/latest/getting-started/).
 
-### Deploying Jaeger
+See also:
 
-To learn more about deploying Jaeger, read the official
-[Getting Started documentation](https://www.jaegertracing.io/docs/latest/getting-started/).
-There is an easy to use [all-in-one Docker image](https://www.jaegertracing.io/docs/latest/getting-started/#AllinoneDockerimage),
-as well as deployment options for [Kubernetes](https://github.com/jaegertracing/jaeger-kubernetes)
-and [OpenShift](https://github.com/jaegertracing/jaeger-openshift).
+- An [all-in-one Docker image](https://www.jaegertracing.io/docs/latest/getting-started/#all-in-one).
+- Deployment options for:
+  - [Kubernetes](https://github.com/jaegertracing/jaeger-kubernetes).
+  - [OpenShift](https://github.com/jaegertracing/jaeger-openshift).
 
-### Enabling Jaeger
+## Link to Jaeger
 
 GitLab provides an easy way to open the Jaeger UI from within your project:
 
@@ -37,5 +36,5 @@ GitLab provides an easy way to open the Jaeger UI from within your project:
    [client libraries](https://www.jaegertracing.io/docs/latest/client-libraries/).
 1. Navigate to your project's **Settings > Operations** and provide the Jaeger URL.
 1. Click **Save changes** for the changes to take effect.
-1. You can now visit **Operations > Tracing** in your project's sidebar and
-   GitLab redirects you to the configured Jaeger URL.
+1. You can now visit **Operations > Tracing** in your project's sidebar and GitLab redirects you to
+   the configured Jaeger URL.

locale/gitlab.pot

@@ -1820,6 +1820,9 @@ msgstr ""
 msgid "Add a Grafana button in the admin sidebar, monitoring section, to access a variety of statistics on the health and performance of GitLab."
 msgstr ""
 
+msgid "Add a Jaeger URL to replace this page with a link to your Jaeger server. You first need to %{link_start_tag}install Jaeger%{link_end_tag}."
+msgstr ""
+
 msgid "Add a bullet list"
 msgstr ""
 
@@ -13488,9 +13491,6 @@ msgstr ""
 msgid "For more information, go to the "
 msgstr ""
 
-msgid "For more information, please review %{link_start_tag}Jaeger's configuration doc%{link_end_tag}"
-msgstr ""
-
 msgid "For more information, see the File Hooks documentation."
 msgstr ""
 
@@ -17951,6 +17951,9 @@ msgstr ""
 msgid "Learn more"
 msgstr ""
 
+msgid "Learn more about %{link_start_tag}Jaeger configuration%{link_end_tag}."
+msgstr ""
+
 msgid "Learn more about %{username}"
 msgstr ""
 
@@ -31680,9 +31683,6 @@ msgstr ""
 msgid "To get started, click the link below to confirm your account."
 msgstr ""
 
-msgid "To get started, link this page to your Jaeger server, or find out how to %{link_start_tag}install Jaeger%{link_end_tag}"
-msgstr ""
-
 msgid "To get started, please enter your Gitea Host URL and a %{link_to_personal_token}."
 msgstr ""
 
@@ -31710,7 +31710,7 @@ msgstr ""
 msgid "To only use CI/CD features for an external repository, choose %{strong_open}CI/CD for external repo%{strong_close}."
 msgstr ""
 
-msgid "To open Jaeger and easily view tracing from GitLab, link the %{link} page to your server"
+msgid "To open Jaeger from GitLab to view tracing from the %{link} page, add a URL to your Jaeger server."
 msgstr ""
 
 msgid "To personalize your GitLab experience, we'd like to know a bit more about you. We won't share this information with anyone."