Skip to content

Commit a0e42bd

Browse files
goanpecamelissawm
andcommitted
Apply suggestions from code review
Co-authored-by: Melissa Weber Mendonça <melissawm@gmail.com>
1 parent bc66414 commit a0e42bd

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

content/docs.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,11 @@ When prompted, enter the details for your project (e.g. project name, organizati
8484

8585
### Sync content from the source repo
8686

87-
The `sync_content.yml` github workflow is in charge of keeping the **original source content** in sync with the translations repository within the Scientific Python Translations organization.
87+
The [`sync_content.yml` github workflow](https://github.com/Scientific-Python-Translations/translations-cookiecutter/blob/main/%7B%7Bcookiecutter.__translations_repo_name%7D%7D/.github/workflows/sync_content.yml) is in charge of keeping the **original source content** in sync with the translations repository within the Scientific Python Translations organization.
8888

8989
This workflow uses the `content-sync` [Github action](https://github.com/Scientific-Python-Translations/content-sync).
9090

91-
### Example: Sync Scipy content
91+
### Example: Sync SciPy content
9292

9393
```yaml
9494
name: Sync Content
@@ -116,16 +116,16 @@ jobs:
116116
token: ${{ secrets.TOKEN }}
117117
```
118118
119-
This ensures your translation repo always has the latest source material in English. If the source content has changed since the latest workflow run,
120-
the translations bot will automatically create a Pull Request, with signed commits, and merge it automatically.
119+
This ensures your translation repo always has the latest source material in English (the chosen source language). If the source content has changed since the latest workflow run,
120+
the translations bot will automatically create a Pull Request with signed commits and merge it automatically.
121121
122-
### Pull Translations from Crowdin
122+
### Pull translations from Crowdin
123123
124-
The `sync_tarnslations.yml` github workflow is in charge of keeping the **translated content** in sync with the translations repository within the Scientific Python Translations organization.
124+
The [`sync_translations.yml` github workflow](https://github.com/Scientific-Python-Translations/translations-cookiecutter/blob/main/%7B%7Bcookiecutter.__translations_repo_name%7D%7D/.github/workflows/sync_translations.yml) is in charge of keeping the **translated content** in sync with the translations repository within the Scientific Python Translations organization.
125125

126126
This workflow uses the `translations-sync` [Github action](https://github.com/Scientific-Python-Translations/translations-sync).
127127

128-
#### Example: Sync Scipy.org translations
128+
#### Example: Sync SciPy.org translations
129129

130130
```yaml
131131
name: Sync Translations
@@ -159,24 +159,24 @@ jobs:
159159
crowdin-token: ${{ secrets.CROWDIN_TOKEN }}
160160
```
161161

162-
Everytime this workflow runs, the translations bot will check for the available languages and check if they meet the translation percentage (90% by default) and approval percentage (0% by default). For every language that passes the criteria, which can be defined by the project mainatiners, a new Pull Request with signed commits will be created in the translations repository and the source repository.
162+
In the Crowdin interface, source strings are _translated_ and then _approved_ (which means a second translator has reviewed and approved the translation of this source string). Everytime this workflow runs, the translations bot will check for the available languages and check if they meet the translation percentage (90% by default) and approval percentage (0% by default). For every language that passes the criteria, which can be defined by the project mainatiners, a new Pull Request with signed commits will be created in the translations repository and the source repository.
163163

164164
To gather information on translators, an additional Pull Request will be created on the translations repository with a `translators.yml` file that lists the details such as username, fullname and avatar from the crowdin site.
165165

166-
All Pull Requests created by the Automations Bot on the translation repositories, will be automatically merged.
166+
All Pull Requests created by the Automations Bot on the translation repositories will be automatically merged.
167167

168168
### Cleaning up
169169

170170
After merging the translations PR, the Crowdin service branch (by default, named `l10n_main`) may 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.
171171

172-
### The Translations Bot
172+
### The translations bot
173173

174174
All automations and pull requests are performed by:
175175
[**@scientificpythontranslations**](https://github.com/scientificpythontranslations)
176176

177177
Make sure to grant the bot appropriate repository permissions and exempt it from branch protection rules if needed.
178178

179-
### 📚 Additional Resources
179+
### 📚 Additional resources
180180

181181
- [How to Translate Content](https://scientific-python-translations.github.io/translate/)
182182
- [FAQ](https://scientific-python-translations.github.io/faq/)

0 commit comments

Comments
 (0)