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 and migrate translating page from wiki #16577

Merged
merged 4 commits into from
May 21, 2024

Conversation

seanbudd
Copy link
Member

@seanbudd seanbudd commented May 20, 2024

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

In order to start the process of updating and migrating the translating documentation, the first page was moved from the wiki:

The following changes were made to update the contents:

  • the translation status links to Crowdin, which neatly tracks the status for the NVDA interface. Instructions for generating structured diffs to check the status of user docs will be linked when they are made.
  • warnings are added to note that docs are out of date in general, until all referenced pages are updated
  • links to the manual process are removed. The manual process was only ever documented for the interface, which has moved crowdin. References to this page will be removed.
  • references to text2tags were updated to markdown, such as removing references to the no longer needed locale.t2tconf
  • Additionally, some grammar and formatting fixes were made such as new lines
  • Removed "Missing information" now that this in the repo, normal issues/PRs apply

Future work

On merge, this wiki page should be updated to link to this doc.
Moving and updating the rest of the translating wiki pages.

@seanbudd seanbudd requested a review from a team as a code owner May 20, 2024 06:50
@seanbudd seanbudd requested a review from SaschaCowley May 20, 2024 06:50
@seanbudd seanbudd requested a review from a team as a code owner May 20, 2024 06:54
projectDocs/translating/readme.md Show resolved Hide resolved
The current process for translation is split between multiple processes:
- Crowdin for the NVDA interface
- The legacy SVN translation system for the User Guide and Changes files
- GitHub for Character Descriptions, Symbols and Gestures
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is a new process. This has not been communicated to translators on the list.
And actually some symbols are being translated on SVN during current beta period...

Symbols are translated regularly. The process to translate the changes from the English symbol file modifications should be clarified IMO:

  • when and how are translators notified of changes in the English symbol file
  • will translators need to do GitHub PRs? Note that some of them may not be familiar with GitHub PRs.
  • until when will these PRs be accepted? Will they be accepted during translation freeze?

Copy link
Member Author

Choose a reason for hiding this comment

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

@michaelDCurran communicated that these files should be updated via GitHub PRs in #15014

@michaelDCurran - can you confirm that we no longer support updating these files in SVN?

As mentioned further down, the guides for translating files need to be updated.
This PR is just refreshing the overall wiki page.
The wiki pages for translating these files will be updated and migrated after this PR.

Copy link
Member

Choose a reason for hiding this comment

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

I never specifically removed support for those files from the system, I was more just uncertain how that worked / if that code still functioned. I think technically they could still be submitted that way. But as soon as we move userGuide / changes to po files, then I would not want to keep the system around only for symbols / gestures. Thus as recommended they should be now submitted in PRs.

Copy link
Collaborator

Choose a reason for hiding this comment

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

First of all, I confirm that symbol translation through SVN still works.

Second, if your intention was that translators rather use PRs to translate symbols during 2024.2 translation period, please be aware that this message does not seem to have been received correctly:

  • no PR has been received yet during this dev cycle for symbol translation in other languages
  • at least 5 languages have translated the new "padding dot" symbol through SVN (da, uk, ru, ta and fr at least)

It seems to me that translating symbols through PRs has actually been planned in #15014, but the actual switch time from SVN to GitHub PRs has not been announced, on contrary to what has been done for interface (nvda.po) switch to CrowdIn, as well as t2t to md switch.

Personally, I understand that you do not plan to use SVN anymore for NVDA translation after the user guide and the change log have switched to CrowdIn. And I agree that it makes sense.
Thought I insist again on the fact that the new process should be documented in NVDA dev doc when possible, i.e. when it is definitive. And during the transition period when no definitive documentation can be written, a good communication on the translators mailing list is needed.

IMO, the process could be the following:

  • When the translation freeze period begins, NV Access sends a message to the translators mailing list with the diff in the English symbol file between release N-1 and last beta of release N.
  • Localized symbol files are updated through PRs during translation freeze period. If translators are uncomfortable with GitHub / PRs, we may imagine alternative / complementary solutions such as NV Access or experimented people gathering updated files and making a common PR on behalf of translators.
  • During translation freeze period, no PR is accepted on symbol file, unless you extend the freeze period.
  • When the translation freeze period is over and the PRs are merged, the RC can be released.

The same process can be used for gesture changes, even if they are much less frequent. There cannot be diffs for gestures, but making an announcement when new/modified gestures are likely to receive a localized translation can be done manually, as I have already done for ultimate such changes.

Cc @gerald-hartig for awareness and opinion.

projectDocs/translating/readme.md Outdated Show resolved Hide resolved
@seanbudd seanbudd added the conceptApproved Similar 'triaged' for issues, PR accepted in theory, implementation needs review. label May 20, 2024
@seanbudd seanbudd merged commit 96ee864 into master May 21, 2024
1 of 2 checks passed
@seanbudd seanbudd deleted the migrateTranslationsWikiToRepo branch May 21, 2024 02:17
@michaelDCurran
Copy link
Member

michaelDCurran commented May 21, 2024 via email

@zstanecic
Copy link
Contributor

zstanecic commented May 21, 2024 via email

@CyrilleB79
Copy link
Collaborator

I'd say that we should continue discussing elsewhere than in this closed PR now; else the discussion will be lost.
Sorry, I was the first to start this half off-toppic discussion.

I suggest to continue #15014 or to open a new GitHubdiscussion.

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.

4 participants