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

Automated Translation Progress Issue #19356

Closed
tesseralis opened this issue Nov 7, 2019 · 1 comment
Closed

Automated Translation Progress Issue #19356

tesseralis opened this issue Nov 7, 2019 · 1 comment
Labels
help wanted Issue with a clear description that the community can help with.

Comments

@tesseralis
Copy link
Contributor

Summary

Automate the way progress issues are generated in translation repositories, similar to the way renovate

Motivation

Keeping the translation progress up-to-date requires a lot of manual work for translation maintainers:

  • Checking the comments and assigning work to people
  • Updating the body of the progress issue as work is updated
  • Checking off checkboxes as pages are translated
  • Adding new pages and sections as work is completed
  • Checking if an assignment is stale and needs to be re-assigned

A lot of this work can be automated to save time.

Steps

Create a new script that will:

  • Add some sort of marker to note pages as translated (e.g. translated: true in the frontmatter)
  • When a commit is written, update the body of the progress issue to check if any new
  • When a comment is made in the progress issue, update it to assign work. We can use a format like in the React Simplified Chinese translation
  • Track if it's been more than a period of time (~2 weeks) since someone has been assigned and remove the assignment if a pull request has not been created.

Alternatives

Alternatively, we can not use issues at all and use Projects or Milestones instead to keep track of translation progress. This has some advantages:

  • More automation built-in: people can assign issues to themselves and GitHub has automated features to move issues through different stages of projects

There are also some disadvantages to this approach:

  • There are a lot of pages to translate, and the issues page for translations could become very polluted very quickly if an issue is created for each page, making it hard to find important issues.
  • It's more complicated and requires a deeper knowledge of how GitHub features work.

Some repos have started doing "hybrid" approaches, splitting up progress issues into different sections of the docs.

Either way, automation would be beneficial for translation maintainers.

@tesseralis tesseralis added help wanted Issue with a clear description that the community can help with. topic: i18n labels Nov 7, 2019
@github-actions
Copy link

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.
If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!
As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜

@github-actions github-actions bot added the stale? Issue that may be closed soon due to the original author not responding any more. label Nov 28, 2019
@LekoArts LekoArts added not stale and removed stale? Issue that may be closed soon due to the original author not responding any more. labels Nov 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Issue with a clear description that the community can help with.
Projects
None yet
Development

No branches or pull requests

2 participants