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

Proposal to map out outdated translations #1480

Open
2 tasks
UlisesGascon opened this issue Apr 2, 2024 · 1 comment
Open
2 tasks

Proposal to map out outdated translations #1480

UlisesGascon opened this issue Apr 2, 2024 · 1 comment

Comments

@UlisesGascon
Copy link
Member

UlisesGascon commented Apr 2, 2024

In our recent TC meeting, we discussed the need for a more efficient method of detecting outdated translated versions of our documentation. Below is a proposal aimed at addressing this issue and enhancing the user experience for our contributors.

Assumptions

  • Typically, changes are made to the English version of the documentation first, without waiting for translations to be completed. (For example, see: PR #1474)
  • Our community is eager to assist with translations (Issue #1237), but it's challenging for them to initiate the process.
  • Identifying which parts of the documentation have changed and need updating in their respective translated versions is difficult, leading to outdated translations.

Workflow

I propose creating a GitHub Action similar to the one discussed in Issue #1479. This action would detect changes made in any version using regex for the paths. It would then add tags in the PR for other versions that need translation, such as needs fr translation and needs sp translation. This tagging system would enable us to easily identify closed PRs requiring translation. For instance, we could filter closed PRs for the French version using a tag-based search: French Version PRs.

If a change doesn't require translation, such as fixing a typo in the English text, we can simply remove the corresponding tags before merging the PR.

Next Steps

  • Develop a GitHub Action to support this workflow.
  • Update the CONTRIBUTING.md guide to incorporate this workflow.
@UlisesGascon UlisesGascon changed the title Proposal for mark outdated translations Proposal to map out outdated translations Apr 2, 2024
@UlisesGascon UlisesGascon pinned this issue Apr 2, 2024
@crandmck
Copy link
Member

crandmck commented Apr 8, 2024

Great idea! Keep in mind that the API doc is not translated, so this only applies to the rest of the doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants