Proposal to map out outdated translations

[Ulises Gascón]

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.

[Rand McKinney]

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