Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Communication: Fix channel creation dialog translation #8769

Merged
merged 10 commits into from
Jun 13, 2024

Conversation

asliayk
Copy link
Contributor

@asliayk asliayk commented Jun 9, 2024

Checklist

General

Client

  • I added multiple screenshots/screencasts of my UI changes.
  • I translated all newly inserted strings into English and German.

Motivation and Context

  • The ‘Announcement Channel’ header in the create channel dialogue is misleading. It should be changed to ‘Announcement / Unrestricted Channel’, like ‘Public / Private Channel’, or 'Channel Type'
  • The ‘Private Channel / Public Channel’ should be changed to ‘Public / Private Channel’ to avoid the duplication and follow the same order as the buttons below, or it can be changed to 'Visibility'
    (The related issue is Communication: Channel Creation Dialogue Translation Improvement #6342)

Description

  • 'Announcement Channel' header has been changed to 'Channel Type'.
  • ‘Private Channel / Public Channel’ has been changed to ‘Visibility’.

Steps for Testing

Prerequisites:

  • 1 Instructor
  1. Log in to Artemis
  2. Navigate to 'Messages' of a course
  3. Click on create new channel button to open the channel creation dialogue

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked






Review Progress

Performance Review

  • I (as a reviewer) confirm that the client changes (in particular related to REST calls and UI responsiveness) are implemented with a very good performance
  • I (as a reviewer) confirm that the server changes (in particular related to database calls) are implemented with a very good performance

Code Review

  • Code Review 1
  • Code Review 2

Manual Tests

  • Test 1
  • Test 2

Exam Mode Test

  • Test 1
  • Test 2

Test Coverage

Screenshots

image

Summary by CodeRabbit

  • Improvements
    • Enhanced clarity of labels related to channel visibility and type:
      • "Private Channel / Public Channel" updated to "Visibility."
      • "Announcement Channel" updated to "Channel Type."
    • Applied to both German and English language settings.

@asliayk asliayk self-assigned this Jun 9, 2024
@asliayk asliayk requested a review from a team as a code owner June 9, 2024 14:42
@github-actions github-actions bot added the client Pull requests that update TypeScript code. (Added Automatically!) label Jun 9, 2024
Copy link

coderabbitai bot commented Jun 9, 2024

Walkthrough

The recent changes focus on renaming labels in JSON files associated with channel visibility and type. These adjustments aim to simplify and generalize the terminology used, enhancing clarity and user understanding. The labels "Private Channel / Public Channel" and "Announcement Channel" have been updated to "Visibility" and "Channel Type," respectively, in both German and English language files.

Changes

Files Change Summary
src/main/webapp/i18n/de/conversation.json Renamed the label for isPublicInput from "Privatkanal / öffentlicher Kanal" to "Sichtbarkeit". Renamed the label for isAnnouncementChannelInput from "Ankündigungskanal" to "Kanaltyp".
src/main/webapp/i18n/en/conversation.json Renamed the label for isPublicInput from "Private Channel / Public Channel" to "Visibility". Renamed the label for isAnnouncementChannelInput from "Announcement Channel" to "Channel Type".

Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between 8ad790e and 4125155.

Files selected for processing (2)
  • src/main/webapp/i18n/de/conversation.json (1 hunks)
  • src/main/webapp/i18n/en/conversation.json (1 hunks)
Additional context used
Path-based instructions (1)
src/main/webapp/i18n/de/conversation.json (1)

Pattern src/main/webapp/i18n/de/**/*.json: German language translations should be informal (dutzen) and should never be formal (sietzen). So the user should always be addressed with "du/dein" and never with "sie/ihr".

Additional comments not posted (3)
src/main/webapp/i18n/en/conversation.json (1)

231-231: The change from "Private Channel / Public Channel" to "Visibility" is clear and aligns well with the intended simplification.

Verification successful

The change from "Private Channel / Public Channel" to "Visibility" is clear and aligns well with the intended simplification. The search results confirm that the new label "Visibility" is present in the expected file and there are no remnants of the old label "Private Channel / Public Channel" in the codebase.

  • src/main/webapp/i18n/en/conversation.json: "label": "Visibility"
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that the label "Visibility" is consistently used across the application.

# Test: Search for the old and new labels. Expect: Only occurrences of the new label.
rg --type json $'\"label\": \"Visibility\"' --glob '*.json'
rg --type json $'\"label\": \"Private Channel / Public Channel\"' --glob '*.json'

Length of output: 224



Script:

#!/bin/bash
# Description: Verify that the label "Visibility" is consistently used across the application.

# Test: Search for the new label "Visibility" in all relevant files.
rg --type json $'\"label\": \"Visibility\"' --glob '*.json'
rg --type js $'\"Visibility\"' --glob '*.js'
rg --type ts $'\"Visibility\"' --glob '*.ts'

# Test: Ensure there are no remnants of the old label "Private Channel / Public Channel".
rg --type json $'\"label\": \"Private Channel / Public Channel\"' --glob '*.json'
rg --type js $'\"Private Channel / Public Channel\"' --glob '*.js'
rg --type ts $'\"Private Channel / Public Channel\"' --glob '*.ts'

Length of output: 444

src/main/webapp/i18n/de/conversation.json (2)

238-238: The change from "Ankündigungskanal" to "Kanaltyp" improves clarity and adheres to the PR's objectives of refining terminology.

Verification successful

The label "Kanaltyp" is consistently used in the JSON files, and there are no occurrences of the old label "Ankündigungskanal" in any file types across the codebase.

  • src/main/webapp/i18n/de/conversation.json: "label": "Kanaltyp"
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that the label "Kanaltyp" is consistently used across the application.

# Test: Search for the old and new labels. Expect: Only occurrences of the new label.
rg --type json $'\"label\": \"Kanaltyp\"' --glob '*.json'
rg --type json $'\"label\": \"Ankündigungskanal\"' --glob '*.json'

Length of output: 205



Script:

#!/bin/bash
# Description: Verify that the label "Kanaltyp" is consistently used across the application.

# Test: Search for the old and new labels in all file types. Expect: Only occurrences of the new label.
rg --type-add 'web:*.{js,html,css}' --type web $'\"label\": \"Kanaltyp\"'
rg --type-add 'web:*.{js,html,css}' --type web $'\"label\": \"Ankündigungskanal\"'

Length of output: 150



Script:

#!/bin/bash
# Description: Verify that the label "Kanaltyp" is consistently used across the application.

# Test: Search for the old and new labels in all file types. Expect: Only occurrences of the new label.
rg $'\"label\": \"Kanaltyp\"'
rg $'\"label\": \"Ankündigungskanal\"'

Length of output: 149


232-232: The update from "Privatkanal / öffentlicher Kanal" to "Sichtbarkeit" is appropriate and maintains the informal tone required for the German version.

Verification successful

The initial verification shows that the new label "Sichtbarkeit" is present in the expected JSON file, and the old label "Privatkanal / öffentlicher Kanal" is not found in any JSON files. To ensure comprehensive verification, let's check other file types where this label might be used.


The search results indicate that neither the new label "Sichtbarkeit" nor the old label "Privatkanal / öffentlicher Kanal" were found in JavaScript or HTML files. To ensure thorough verification, let's search across all file types.


The search results confirm that the new label "Sichtbarkeit" is present in the expected JSON files, and the old label "Privatkanal / öffentlicher Kanal" is not found anywhere in the codebase. This indicates that the change has been correctly applied and is consistent across the application.

  • src/main/webapp/i18n/de/conversation.json: "label": "Sichtbarkeit"
  • src/main/webapp/i18n/de/programmingExercise.json: "visibility": "Sichtbarkeit"
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that the label "Sichtbarkeit" is consistently used across the application.

# Test: Search for the old and new labels. Expect: Only occurrences of the new label.
rg --type json $'\"label\": \"Sichtbarkeit\"' --glob '*.json'
rg --type json $'\"label\": \"Privatkanal / öffentlicher Kanal\"' --glob '*.json'

Length of output: 228



Script:

#!/bin/bash
# Description: Verify that the label "Sichtbarkeit" is consistently used across the application in various file types.

# Test: Search for the old and new labels in JavaScript and HTML files. Expect: Only occurrences of the new label.
rg --type js $'\"Sichtbarkeit\"' --glob '*.js'
rg --type js $'\"Privatkanal / öffentlicher Kanal\"' --glob '*.js'
rg --type html $'\"Sichtbarkeit\"' --glob '*.html'
rg --type html $'\"Privatkanal / öffentlicher Kanal\"' --glob '*.html'

Length of output: 231



Script:

#!/bin/bash
# Description: Verify that the label "Sichtbarkeit" is consistently used across the application in all file types.

# Test: Search for the old and new labels across all file types. Expect: Only occurrences of the new label.
rg $'\"Sichtbarkeit\"'
rg $'\"Privatkanal / öffentlicher Kanal\"'

Length of output: 253


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jun 9, 2024
@Strohgelaender
Copy link
Contributor

I think a more fitting header for the selection between public and private would be "Visibility". What do you think? And for the "Announcement / Unrestricted Channel" selection maybe "Channel type" would be fitting?

marlon-luca-bu
marlon-luca-bu previously approved these changes Jun 9, 2024
Copy link
Contributor

@edkaya edkaya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @Strohgelaender, I think "Channel Visibility" and "Channel Type" are more suitable.

dmytropolityka
dmytropolityka previously approved these changes Jun 10, 2024
asliayk added 2 commits June 10, 2024 10:48
…ader-improvement' into bugfix/communication/dialogue-header-improvement
coderabbitai[bot]
coderabbitai bot previously approved these changes Jun 10, 2024
asliayk and others added 2 commits June 10, 2024 18:53
Co-authored-by: Lucas Welscher <ga53foy@mytum.de>
Co-authored-by: Lucas Welscher <ga53foy@mytum.de>
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

src/main/webapp/i18n/en/conversation.json Show resolved Hide resolved
Copy link
Contributor

@marlon-luca-bu marlon-luca-bu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reapprove

Copy link
Contributor

@edkaya edkaya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes. Code lgtm

Copy link
Contributor

@pzdr7 pzdr7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally. LGTM

@krusche krusche changed the title Communication: Fix channel creation dialogue translation headers Communication: Fix channel creation dialog translation Jun 13, 2024
@krusche krusche added this to the 7.2.1 milestone Jun 13, 2024
@krusche krusche merged commit 8e0325d into develop Jun 13, 2024
41 checks passed
@krusche krusche deleted the bugfix/communication/dialogue-header-improvement branch June 13, 2024 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix client Pull requests that update TypeScript code. (Added Automatically!) ready to merge small
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

7 participants