Skip to content

Commit 9f7046a

Browse files
authored
Merge pull request #864 from parente/tx-howto
Draft pages about translation
2 parents bce6382 + b497b27 commit 9f7046a

File tree

3 files changed

+34
-1
lines changed

3 files changed

+34
-1
lines changed

docs/contributing/translations.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Doc Translations
2+
3+
We are delighted when members of the Jupyter community want to help translate these documentation pages to other languages. If you're interested, please follow the steps below to join our team on [Transifex](https://transifex.com) and to start creating, reviewing, and updating translations of the Jupyter Docker Stacks documentation:
4+
5+
1. Follow the steps documented on the [Getting Started as a Translator](https://docs.transifex.com/getting-started-1/translators) page.
6+
2. Look for *jupyter-docker-stacks* when prompted to choose a translation team. Alternatively, visit https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1 after creating your account and request to join the project.
7+
3. See [Translating with the Web Editor](https://docs.transifex.com/translation/translating-with-the-web-editor) in the Transifex documentation.

docs/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,10 @@ Table of Contents
4343
:maxdepth: 2
4444
:caption: Contributor Guide
4545

46-
contributing/issues
46+
contributing/issues
4747
contributing/packages
4848
contributing/recipes
49+
contributing/translations
4950
contributing/tests
5051
contributing/features
5152
contributing/stacks

docs/maintaining/tasks.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,28 @@ If automated builds on Docker Cloud have got you down, do the following to push
5555
2. Check out the git SHA you want to build and publish.
5656
3. `docker login` with your Docker Hub/Cloud credentials.
5757
4. Run `make retry/release-all`.
58+
59+
## Enabling a New Doc Language Translation
60+
61+
First enable translation on Transifex:
62+
63+
1. Visit https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1/languages/
64+
2. Click *Edit Languages* in the top right.
65+
3. Select the language from the dropdown.
66+
4. Click *Apply*.
67+
68+
Then setup a subproject on ReadTheDocs for the language:
69+
70+
1. Visit https://readthedocs.org/dashboard/import/manual/
71+
2. Enter *jupyter-docker-stacks-<lang>* for the project name.
72+
3. Enter https://github.com/jupyter/docker-stacks for the URL.
73+
4. Check *Edit advanced project options*.
74+
5. Click *Next*.
75+
6. Select the *Language* from the dropdown on the next screen.
76+
7. Click *Finish*.
77+
78+
Finally link the new language subproject to the top level doc project:
79+
80+
1. Visit https://readthedocs.org/dashboard/jupyter-docker-stacks/translations/
81+
2. Select the subproject you created from the *Project* dropdown.
82+
3. Click *Add*.

0 commit comments

Comments
 (0)