-
Notifications
You must be signed in to change notification settings - Fork 3
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
feat: add translation processes #109
base: main
Are you sure you want to change the base?
Conversation
lwasser
commented
Nov 9, 2024
•
edited
Loading
edited
- To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1208768410555067
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made two minor additions.
We should also consider adding a process to start a new language translation: if someone volunteers to work on a new language, who makes the go-ahead decision, designates the translation group/lead, etc.
Back when I wrote the Translation guide for contributors I added a bit of information for the technical steps here but no other guidance.
These are the checks a reviewer should incorporate into their review. | ||
* Verify that the translation can be built in the PR branch without warnings | ||
* Example for Spanish translation: `nox -s docs-live-lang -- es` | ||
* The command can be used for any language by swapping out the language tag at the end. A list of Sphinx language tags can be [found here](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* The command can be used for any language by swapping out the language tag at the end. A list of Sphinx language tags can be [found here](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language). | |
* The command can be used for any language by swapping out the language tag at the end. The current list of languages that are being actively worked on can be found in the [Packaging Guide noxfile.py](https://github.com/pyOpenSci/python-package-guide/blob/d0c05fac6c28097e60b7206e1ba5314ab869804c/noxfile.py#L45) file. A complete list of Sphinx language tags can be [found here](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language). |
|
||
## Additional automations for consideration | ||
|
||
Use CI to automatically tag the PR with the translation and the proper language tags. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use CI to automatically tag the PR with the translation and the proper language tags. | |
- Use CI to automatically tag the PR with the translation and the proper language tags. | |
- Use CI to automatically keep the translation files updated once a translation has been released (work in progress [PR #397](https://github.com/pyOpenSci/python-package-guide/pull/397)) |