Skip to content

CTRT Restructure contribution analytics

Lorena Ciutacu requested to merge lc-ctrt-contribution-analytics into master

What does this MR do?

  • Reorders the "Change time period" section after "Sort contributions". The thinking behind this change is that the selected time frame applies to all charts and the table; the View and Sorting sections refer to the contribution analytics data, in the order they're displayed on the page (charts followed by a table), so it makes more sense to list them in this order.
  • Makes the sections that refer to interacting with the charts subsections of "View contribution analytics", and adds a subsection with instructions for zooming in on charts.
  • Changes the verb form of headings.
Before After
Page https://docs.gitlab.com/ee/user/group/contribution_analytics/index.html https://main-ee-111294.docs.gitlab-review.app/ee/user/group/contribution_analytics/
Reading score 7.08 6.69

Other proposed changes (in this or a follow-up MR):

  • Remove screenshots.
  • Edit the language (e.g. rephrase sentences to follow the reason-location-action structure).
  • Update instructions/information in the sections "Change time period" and "Sort contributions".

Related issues

technical-writing#749 (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 Lorena Ciutacu

Merge request reports