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

Admin UI: Use l10n translations everywhere #692

Merged
merged 55 commits into from
Jul 8, 2024

Conversation

stamenione
Copy link
Contributor

Readiness checklist

  • I added/updated unit tests.
  • I added/updated integration tests.
  • I ensured that the PR title is good enough for the changelog.
  • I labeled the PR.

@stamenione stamenione added the enhancement New feature or request label Jun 11, 2024
@stamenione stamenione self-assigned this Jun 11, 2024
@stamenione stamenione requested a review from jkoenig134 as a code owner June 11, 2024 08:15
Copy link

coderabbitai bot commented Jun 11, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

Labels to auto review (1)
  • dependencies

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Tip

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are currently opted into early access features by default.

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.

@tnotheis tnotheis requested a review from Siolto June 19, 2024 14:38
@jkoenig134 jkoenig134 changed the title Admin UI: Preparation for translation Admin UI: Use l10n translations everywhere Jun 26, 2024
@stamenione stamenione requested a review from jkoenig134 June 27, 2024 10:53
@jkoenig134
Copy link
Member

I think we will have to refactor these translations again, i don't care if this happens in this PR or in another. When looking at the translations in the enmeshed App you see that we scope translations.

  • general translations like cancel, add, etc. are on global scope b/c they are re-used in the whole application
  • translations that belong to a specific screen / feature are scoped. Take the example list_of_all_clients - for this translation you have no idea where this translation is used. The key of the translation should not be just a _ separated version of the english translation. Instead use clients_overview_title if you have multiple word in one scope camelCase these words, for example topLevel_pageWithMoreWords_aKeyThatNeedsMoreThanOneWord

@tnotheis do you agree? If yes - this PR or another?

@tnotheis
Copy link
Member

I think we will have to refactor these translations again, i don't care if this happens in this PR or in another. When looking at the translations in the enmeshed App you see that we scope translations.

  • general translations like cancel, add, etc. are on global scope b/c they are re-used in the whole application
  • translations that belong to a specific screen / feature are scoped. Take the example list_of_all_clients - for this translation you have no idea where this translation is used. The key of the translation should not be just a _ separated version of the english translation. Instead use clients_overview_title if you have multiple word in one scope camelCase these words, for example topLevel_pageWithMoreWords_aKeyThatNeedsMoreThanOneWord

@tnotheis do you agree? If yes - this PR or another?

I totally agree, yes. And it should be done in this PR.

@stamenione stamenione merged commit 0ad6c4e into main Jul 8, 2024
20 checks passed
@stamenione stamenione deleted the NMSHDB-143-Admin-UI-Preparation-for-translation branch July 8, 2024 07:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants