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

Update information for translating the interface with Crowdin #16718

Merged
merged 19 commits into from
Jul 2, 2024

Conversation

seanbudd
Copy link
Member

@seanbudd seanbudd commented Jun 18, 2024

Link to issue number:

Closes #16656

Summary of the issue:

NV Access is intending to move most of the wiki into the repository, so changes are tracked better and easier to propose.
The documentation for translating NVDA is very dated, particularly since the update of the translation system.

Description of user facing changes

This wiki page was moved and updated in the project docs

The following changes were made to update the contents:

  • grammar and formatting fixes
  • add reference to user guide commands for PoEdit
  • remove section on translating using a text editor
  • added information on:
    • on using Crowdin and proofreader status
    • plural forms
    • pgettext (context/tags)

Future work

This wiki pages will be removed/deprecated when this PR is merged.
Moving and updating the rest of the translating wiki pages.

Summary by CodeRabbit

  • Documentation

    • Added a new guide for translating the NVDA interface using Crowdin.
    • Enhanced translation readme with improved formatting and updated references.
  • Chores

    • Updated links in translation files to direct to the new Crowdin documentation.

@seanbudd seanbudd requested a review from a team as a code owner June 18, 2024 05:18
@seanbudd seanbudd requested a review from michaelDCurran June 18, 2024 05:18
Copy link
Contributor

coderabbitai bot commented Jun 18, 2024

Walkthrough

The changes involved updating and adding documentation for translating NVDA's interface using Crowdin. This includes creating a new crowdin.md file with instructions and modifying the readme.md with emphasis on subscription to the translation mailing list and clarifying processes for new localizations.

Changes

File Change Summary
projectDocs/translating/crowdin.md Added a new file providing detailed instructions for translating NVDA using Crowdin.
projectDocs/translating/readme.md Added blank lines, emphasized subscription to the translation mailing list, clarified localization process, and updated translation resources reference.
nvda.po Updated the reference for translating NVDA's interface messages to point to the new crowdin.md file.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Guidance on translating the NVDA interface (#16656)
Update documentation for transition to using Crowdin (#16627)

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.

Copy link
Contributor

@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: 7

Outside diff range and nitpick comments (4)
projectDocs/translating/readme.md (4)

Line range hint 3-3: Correct the verb form for better grammatical accuracy.

- Thank you for considering to localize NVDA to your language, or improving an existing translation.
+ Thank you for considering localizing NVDA to your language, or improving an existing translation.
Tools
LanguageTool

[uncategorized] ~11-~11: The preposition ‘to’ seems more likely in this position. (AI_HYDRA_LEO_REPLACE_FOR_TO)
Context: ... is an English low traffic list devoted for the discussion of translation.
Import...


Line range hint 12-12: Add hyphens to 'up-to-date' for grammatical correctness.

- Important messages that relate to translators will also be sent here, e.g. before official NVDA releases, to remind translators to make sure their localization is up to date.
+ Important messages that relate to translators will also be sent here, e.g. before official NVDA releases, to remind translators to make sure their localization is up-to-date.

- Translators should ensure their translation is up to date during the beta period before each new release, in order for it to be included in the upcoming final release.
+ Translators should ensure their translation is up-to-date during the beta period before each new release, in order for it to be included in the upcoming final release.

- You can view [Crowdin](https://crowdin.com/project/nvda) for an up to date report on the status of translating the NVDA interface.
+ You can view [Crowdin](https://crowdin.com/project/nvda) for an up-to-date report on the status of translating the NVDA interface.

Also applies to: 16-16, 23-23

Tools
LanguageTool

[uncategorized] ~11-~11: The preposition ‘to’ seems more likely in this position. (AI_HYDRA_LEO_REPLACE_FOR_TO)
Context: ... is an English low traffic list devoted for the discussion of translation.
Import...


Line range hint 19-19: Add a comma after 'information' for better readability.

- For further information please see the [Release Process page](https://github.com/nvaccess/nvda/blob/master/projectDocs/community/releaseProcess.md).
+ For further information, please see the [Release Process page](https://github.com/nvaccess/nvda/blob/master/projectDocs/community/releaseProcess.md).
Tools
LanguageTool

[uncategorized] ~11-~11: The preposition ‘to’ seems more likely in this position. (AI_HYDRA_LEO_REPLACE_FOR_TO)
Context: ... is an English low traffic list devoted for the discussion of translation.
Import...


Line range hint 47-47: Change 'send an email' to 'email' for conciseness.

- You can send an email to the translation mailing list to find out the correct person.
+ You can email the translation mailing list to find out the correct person.
Tools
LanguageTool

[uncategorized] ~11-~11: The preposition ‘to’ seems more likely in this position. (AI_HYDRA_LEO_REPLACE_FOR_TO)
Context: ... is an English low traffic list devoted for the discussion of translation.
Import...

projectDocs/translating/readme.md Outdated Show resolved Hide resolved
projectDocs/translating/readme.md Outdated Show resolved Hide resolved
projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
seanbudd and others added 7 commits June 18, 2024 15:28
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Collaborator

@CyrilleB79 CyrilleB79 left a comment

Choose a reason for hiding this comment

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

As a general comment:

There is no paragraph to describe the usage of the web interface; does it mean that NVDA recommends poedit? poedit does not allow to see the unapproved translation proposals of other people.

My feeling is that there are 2 use cases to translate the interface for a specific language:

  1. If there is only one translator of the interface for a specific language; in this case the usage of poedit is recommanded because it is easier. Note that to send a po file with approval; synchronization does not seem enough; you need to manually upload your file on Crowdin's web interface, checking the approval checkbox.
  2. If there are many translators for the interface; in this case, the web interface, although less comfortable, cannot be avoided

projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
@seanbudd seanbudd marked this pull request as draft June 18, 2024 23:51
@seanbudd seanbudd marked this pull request as ready for review June 19, 2024 04:16
projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
projectDocs/translating/crowdin.md Outdated Show resolved Hide resolved
@seanbudd seanbudd marked this pull request as draft June 20, 2024 05:27
@seanbudd seanbudd marked this pull request as ready for review June 20, 2024 06:16
@seanbudd seanbudd requested a review from CyrilleB79 June 20, 2024 06:16
@CyrilleB79
Copy link
Collaborator

@seanbudd thanks, you have taken into consideration my comments.

However, I am quite concerned by the way this documentation is written. There seems to be actually 3 ways to translate:

  1. Only on Crowdin's web interface, either with only one proof reader translator approving directly their translations or with many translators making suggestions and a proof reading approving them in a second step.
  2. With only one proof reader translator translating on poedit without cloud synchronization and uploading manually the file checking the auto-approve checkbox
  3. With one ore more translators translating on poedit synchronized with Crowdin's cloud and one proof reader approving the translations on Crowdin.

And the documentation seems to mention parts of the process for one way or the other but does not make a clear distinction between these possible processes, i.e. steps from 2 distinctive processes seems a bit mixed together. The consequence is that a user will have difficulty to identify a step-by-step process to follow.

Note however that I may not master all the possible processes, taking into account that I personally do not feel Crowdin very easy cand comfortable to use. That's why I had asked to other people on the translators mailing list to review this PR. Unfortunately no one has shown up.

Maybe @ruifontes, @Adriani90, @zstanecic would you mind review this PR?

@seanbudd
Copy link
Member Author

@CyrilleB79 - I'll add a rough outline at the start of the documented covering an overview of these main workflow processes. I think this will help clarify the rest of the instructions

@seanbudd seanbudd marked this pull request as draft June 26, 2024 03:30
@seanbudd seanbudd marked this pull request as ready for review June 27, 2024 02:04
@seanbudd
Copy link
Member Author

@CyrilleB79 - I've added a new section

@seanbudd seanbudd marked this pull request as draft June 27, 2024 07:21
@seanbudd seanbudd marked this pull request as ready for review June 27, 2024 07:36
@CyrilleB79
Copy link
Collaborator

@seanbudd I am unsure the document is complete, but I have no other feedback for now. I would have appreciated that other translators comment here but this has not been the case. If no other feedback is received, I'd recommend to merge as is and to update the document in another PR in case we get more feedback in the future. I'll try a last call on the translators mailiing list since the strings for 2024.3 have just been made available for translation.

Also, have you tried yourself all what is written in the document? If not, it would be useful given the lack of received feedback.

@CyrilleB79
Copy link
Collaborator

On the translators mailing list, someone offered to contribute with a tutorial for Crowdin-only usage.
See this thread.
@seanbudd would you accept it?

@seanbudd
Copy link
Member Author

@CyrilleB79 - thanks for the feedback. I've responded to the mailing list. And yes, to confirm, I've gone through all the processes with NVDA up to the point of committing any changes.

@seanbudd seanbudd merged commit fa69e63 into master Jul 2, 2024
3 checks passed
@seanbudd seanbudd deleted the addCrowdinDocs branch July 2, 2024 00:54
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add / update the documentation to translate NVDA's interface (nvda.po)
3 participants