[go: up one dir, main page]
Skip to content

Rename user-facing strings with "discussions"?

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

I learned today that the translations team is now struggling with a concept that has been problematic for groupcode review: distinguishing the terms discussion, thread, and comment. While I cannot — and should not — speak about the underlying code, which uses the string discussion, I think we could make the concepts simpler for translators — and our users.

This question is bigger than just groupcode review or devopscreate, so let me start by capturing current usage here, and building a proposal for changing the UI strings.

Show me what's in `gitlab.pot`!

Each line is a different string in gitlab.pot. I edited the original output to make it easier to read:

  • "%{resolvedDiscussionsCount} of %{resolvableDiscussionsCount}"
  • "%{resolvedDiscussionsCount} of %{resolvableDiscussionsCount} thread resolved" gitlab.pot:msgid_plural "%{resolvedDiscussionsCount} of %{resolvableDiscussionsCount} threads resolved"
  • "DesignManagement|Could not create new discussion. Please try again."
  • "DesignManagement|Could not update discussion. Please try again."
  • "DesignManagement|Discussion"
  • "Discussion locked."
  • "Discussion to reply to cannot be found"
  • "Discussion unlocked."
  • "DuoEnterpriseDiscover|Discussion, merge request, and code summaries for efficient and effective communication."
  • "DuoEnterprise|Easily get up to speed on issue discussions with concise overviews of proposed code changes"
  • "Lock discussion"
  • "Lock the discussion"
  • "Lock this discussion? Only %{strongStart}project members%{strongEnd} will be able to comment."
  • "Locked the discussion."
  • "Locking discussion"
  • "Locks the discussion."
  • "MergeRequest|Can't fetch the single file diff for the discussion. Please reload this page."
  • "Notify|All discussions on merge request %{mr_link} were resolved by %{name}"
  • "Only Merge Requests are allowed as a noteable to resolve discussions of at the moment."
  • "Only project level work items can be created to resolve noteable discussions"
  • "Please %{registerLinkStart}register%{registerLinkEnd} or %{signInLinkStart}sign in%{signInLinkEnd} to start a new discussion."
  • "Projects|Projects where you contribute code, create issues or epics, or participate in discussions will appear here."
  • "Reply to this email to participate in the discussion. All other participants of the ticket will receive notifications of your reply."
  • "Resolved 1 discussion."
  • "Resolved all discussions."
  • "ServiceDesk|Like the author, external participants receive Service Desk emails and can participate in the discussion."
  • "Something went wrong trying to change the locked state of the discussion"
  • "Something went wrong while resolving this discussion. Please try again."
  • "The discussion in this %{issuableDisplayName} is locked. Only project members can comment."
  • "The discussion in this %{issuable} is locked. Only project members can comment."
  • "The discussion in this %{noteableTypeText} is locked."
  • "The discussion in this Wiki is locked. Only project members can comment."
  • "The discussion in this merge request is locked." gitlab.pot:msgid_plural "All %{resolvableDiscussionsCount} threads resolved"
  • "This %{noteableTypeText} is %{confidentialLinkStart}confidential%{confidentialLinkEnd} and its %{lockedLinkStart}discussion is locked%{lockedLinkEnd}."
  • "Unlock discussion"
  • "Unlock the discussion"
  • "Unlock this discussion? %{strongStart}Everyone%{strongEnd} will be able to comment."
  • "Unlocked the discussion."
  • "Unlocking discussion"
  • "Unlocks the discussion."
  • "Unresolved discussions must be resolved."
  • "You are about to add %{usersTag} people to the discussion. They will all receive a notification."
  • "started a discussion on %{design_link}"

Proposal

I think we have two base concepts: a comment, which is a single response from a user, and a thread (or comment thread) which is a chain of individual comments that have a parent-child relationship. I acknowledge it's a more complex than this simplistic example, but I think we can rephrase the existing user-facing strings in such a way to eliminate discussions - which is a nebulous extra noun.

Some before and after examples:

Before After
Easily get up to speed on issue discussions with concise overviews of proposed code changes Easily get up to speed on an issue, with concise overviews of proposed code changes
Lock discussion Lock comments
All discussions on merge request %{mr_link} were resolved by %{name} All threads on merge request %{mr_link} were resolved by %{name} OR
%{name} resolved all threads on merge request %{mr_link}
Could not update discussion. Please try again. Could not update comments. Please try again.
Projects where you contribute code, create issues or epics, or participate in discussions will appear here. Projects where you contribute code, create issues or epics, or talk about changes will appear here.
Like the author, external participants receive Service Desk emails and can participate in the discussion. Like the author, external participants receive Service Desk emails and can comment.

I don't think we need discussions as a separate term, but I'd like to hear the thoughts of others.

Edited by 🤖 GitLab Bot 🤖