Skip to content

Commit dd374fb

Browse files
committed
Upodate maintainers docs
1 parent 395549a commit dd374fb

1 file changed

Lines changed: 44 additions & 37 deletions

File tree

content/docs.md

Lines changed: 44 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ https://github.com/Scientific-Python-Translations/automations/.
1818
[Crowdin](https://scientific-python.crowdin.com/) provides GitHub integration
1919
tools to sync all translated content from the Crowdin web interface into project
2020
websites and vice-versa. However, a few adaptations are needed. The following
21-
steps describe what maintainers need to do to set up the integration. See [](#automations) for more details on this script.
21+
steps describe what maintainers need to do to set up the integration.
2222

2323
### Setting up Crowdin
2424

@@ -32,10 +32,10 @@ for help. For more information, see
3232

3333
To prevent extra activity in the original source repository, we recommend
3434
creating a separate repository for the translations under
35-
https://github.com/scientific-python-translations with a GitHub action to sync
36-
the translations to the original repository (see
37-
[sync.yml](https://github.com/Scientific-Python-Translations/scipy.org-translations/blob/main/.github/workflows/sync.yml)
38-
for an example).
35+
https://github.com/scientific-python-translations. To get you started with the project
36+
repository we provide a [translations-cookiecutter](https://github.com/Scientific-Python-Translations/translations-cookiecutter) template.
37+
38+
This template includes the necessary workflows that will run periodically to keep the infrastructure in sync. See [](#automations) for more details.
3939

4040
### Announce your project to potential translators
4141

@@ -49,37 +49,6 @@ later.
4949
You can find potential translators by reaching out in the `#translation` channel
5050
on the [Scientific Python Discord server](https://discord.com/invite/vur45CbwMz).
5151

52-
### Merging translations
53-
54-
As translators work on the Crowdin platform, a Pull Request is automatically
55-
created in the project repository. This PR **should not** be merged, as it
56-
contains all translations for all languages (see
57-
[numpy/numpy.org#778](https://github.com/numpy/numpy.org/pull/778) for an
58-
example). If your website is set up through the Scientific Python Translations
59-
org, this PR will have the `do-not-merge` label applied to it.
60-
61-
After translations for a language are completed and ready to be deployed, you
62-
should:
63-
64-
1. Go to the repository corresponding to your project's sources under
65-
https://github.com/Scientific-Python-Translations
66-
2. Go to the Actions tab
67-
3. Manually trigger the "Create translations PR" workflow, with the language
68-
code for your language of interest as input.
69-
70-
<center><img alt="Screenshot of the Actions tab from GitHub, with the Create translations PR workflow highlighted." src="../images/create_translations.png" width=800/></center>
71-
72-
<center><img alt="Screenshot of the Run workflow dialog from GitHub, with an input field labeled Crowding language code for the language of interest" src="../images/run_workflow.png" width=800/></center>
73-
74-
After these steps, a PR will be created to your website repo with the
75-
translations for the language you selected (see
76-
[numpy/numpy.org#774](https://github.com/numpy/numpy.org/pull/774) for an example.) This PR should be
77-
merged when you are ready to publish the translations.
78-
79-
### Cleaning up
80-
81-
After merging the translations PR, the Crowdin service branch (by default, named `l10n_main`) will have merge conflicts with `main`. To fix this, delete the Crowdin service branch. Crowdin will automatically recreate the service branch with merge conflicts resolved. This same process can also be used to resolve merge conflicts if translations are updated outside of Crowdin.
82-
8352
## Automation details
8453

8554
Once a GitHub repository has been synced to Crowdin using the Scientific Python
@@ -130,4 +99,42 @@ This work is in progress - follow [pydata/pydata-sphinx-theme#507](https://githu
13099
Translations may not always be up to date for items such as news items and
131100
release announcements. In this case, your project can decide what to do with
132101
these items (for example, keep them in English or hide them from the deployed
133-
site.)
102+
site.)
103+
104+
105+
106+
107+
----
108+
109+
110+
### Merging translations
111+
112+
As translators work on the Crowdin platform, a Pull Request is automatically
113+
created in the project repository. This PR **should not** be merged, as it
114+
contains all translations for all languages (see
115+
[Scientific-Python-Translations/scipy.org-translations#187](https://github.com/Scientific-Python-Translations/scipy.org-translations/pull/187) for an
116+
example). If your website is set up through the Scientific Python Translations
117+
org, this PR will should have the `do-not-merge` label applied to it to ensure the PR
118+
will not be merged accidentally.
119+
120+
After translations for a language are completed and ready to be deployed, you
121+
should:
122+
123+
1. Go to the repository corresponding to your project's sources under
124+
https://github.com/Scientific-Python-Translations
125+
2. Go to the Actions tab
126+
3. Manually trigger the "Create translations PR" workflow, with the language
127+
code for your language of interest as input.
128+
129+
<center><img alt="Screenshot of the Actions tab from GitHub, with the Create translations PR workflow highlighted." src="../images/create_translations.png" width=800/></center>
130+
131+
<center><img alt="Screenshot of the Run workflow dialog from GitHub, with an input field labeled Crowding language code for the language of interest" src="../images/run_workflow.png" width=800/></center>
132+
133+
After these steps, a PR will be created to your website repo with the
134+
translations for the language you selected (see
135+
[numpy/numpy.org#774](https://github.com/numpy/numpy.org/pull/774) for an example.) This PR should be
136+
merged when you are ready to publish the translations.
137+
138+
### Cleaning up
139+
140+
After merging the translations PR, the Crowdin service branch (by default, named `l10n_main`) will have merge conflicts with `main`. To fix this, delete the Crowdin service branch. Crowdin will automatically recreate the service branch with merge conflicts resolved. This same process can also be used to resolve merge conflicts if translations are updated outside of Crowdin.

0 commit comments

Comments
 (0)