Skip to content

Use more verbose alert messages

Amy Qualls requested to merge aqualls-opstrace-errors into master

What does this MR do?

Improves error messages for groupobservability as part of gitlab-org/opstrace/opstrace#2474 (closed). Specifically, this discussion: gitlab-org/opstrace/opstrace#2474 (comment 1623504320)

NOTE: I know my initial changes are wrong. However, it's tough to revise strings in an issue. More easily done here.

Message Location
Failed to enable GitLab Observability. app/assets/javascripts/observability/components/provisioned_observability_container.vue
Failed to load page. app/assets/javascripts/observability/components/provisioned_observability_container.vue
Failed to load trace details. ee/app/assets/javascripts/tracing/components/tracing_details.vue
Something went wrong while fetching the operations ee/app/assets/javascripts/tracing/components/operation_search_token.vue
Something went wrong while fetching the services ee/app/assets/javascripts/tracing/components/service_search_token.vue

Related issues

Related to Review text/messages with technical writer (gitlab-org/opstrace/opstrace#2474 - closed) (specifically the threads about error messaging)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Amy Qualls

Merge request reports