Proposal to map out outdated translations

[UlisesGascon]

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.

[crandmck]

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

[carlosstenzel]

@crandmck @UlisesGascon @bjohansebas @chrisdel101

Hello team,

I developed a script that creates a page with translation statuses.

But :´( the action doesn't work

I think it could be a configuration for action

I forced the manual creation of the page, to view

https://deploy-preview-1586--expressjscom-preview.netlify.app/en/resources/status-translate

Would anyone like to help me develop this idea? or solve the action problem?

[bjohansebas]

Maybe it could work to add these lines during the checkout in GitHub Actions, so it references the branch.

- uses: actions/checkout@v3
      with:
        fetch-depth: 0
        ref: ${{ github.event.pull_request.head.ref }}

edit: I saw that you tried that, I'll keep investigating. edit: I've tested it in my repo (see https://github.com/bjohansebas/expressjs.com/pull/5), and with the suggested change, it works fine. If it doesn't work with these changes in the official repo, it might be a permissions issue.

[carlosstenzel]

@bjohansebas thanks for the feedback, it's probably permissions. @crandmck can you help us?

[crandmck]

It looks like @UlisesGascon did something very similar to this in https://github.com/expressjs/expressjs.com/pull/1514 ... Unless I'm misunderstanding.

For example, I notice that this PR I opened today automatically was tagged with numerous needs-translation-xx labels.

Can you guys clarify if there's a difference between this PR and what the above PR did?

[carlosstenzel]

The permission to add labels or commits depends on who executes it. For you, write is allowed, for others it is only read.

Your

other people