diff --git a/docs/contributing/translations.md b/docs/contributing/translations.md new file mode 100644 index 00000000..fbd0734d --- /dev/null +++ b/docs/contributing/translations.md @@ -0,0 +1,7 @@ +# Doc Translations + +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: + +1. Follow the steps documented on the [Getting Started as a Translator](https://docs.transifex.com/getting-started-1/translators) page. +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. +3. See [Translating with the Web Editor](https://docs.transifex.com/translation/translating-with-the-web-editor) in the Transifex documentation. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index fd7beb08..c255a720 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -43,9 +43,10 @@ Table of Contents :maxdepth: 2 :caption: Contributor Guide - contributing/issues + contributing/issues contributing/packages contributing/recipes + contributing/translations contributing/tests contributing/features contributing/stacks diff --git a/docs/maintaining/tasks.md b/docs/maintaining/tasks.md index f43b831c..faf1f4f3 100644 --- a/docs/maintaining/tasks.md +++ b/docs/maintaining/tasks.md @@ -55,3 +55,28 @@ If automated builds on Docker Cloud have got you down, do the following to push 2. Check out the git SHA you want to build and publish. 3. `docker login` with your Docker Hub/Cloud credentials. 4. Run `make retry/release-all`. + +## Enabling a New Doc Language Translation + +First enable translation on Transifex: + +1. Visit https://www.transifex.com/project-jupyter/jupyter-docker-stacks-1/languages/ +2. Click *Edit Languages* in the top right. +3. Select the language from the dropdown. +4. Click *Apply*. + +Then setup a subproject on ReadTheDocs for the language: + +1. Visit https://readthedocs.org/dashboard/import/manual/ +2. Enter *jupyter-docker-stacks-* for the project name. +3. Enter https://github.com/jupyter/docker-stacks for the URL. +4. Check *Edit advanced project options*. +5. Click *Next*. +6. Select the *Language* from the dropdown on the next screen. +7. Click *Finish*. + +Finally link the new language subproject to the top level doc project: + +1. Visit https://readthedocs.org/dashboard/jupyter-docker-stacks/translations/ +2. Select the subproject you created from the *Project* dropdown. +3. Click *Add*.