Skip to content

Change 'children spans' to 'child spans'

Amy Qualls requested to merge aqualls-child-span-language into master

What does this MR do?

Updates the string expand children spans to expand child spans. It's a change to an ARIA label, and so invisible to users who do not rely on ARIA navigation.

In this thread we discussed various possibilities, and were nearly settled on Expand child spans. When I looked at ee/app/assets/javascripts/tracing/components/tracing_details_spans_chart.vue I realized this string probably handled both the open and closed states of the parent span, which meant expand would be wrong 50% of the time.

Toggle, then.

Related issues

Related to Review text/messages with technical writer (gitlab-org/opstrace/opstrace#2474 - closed)

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