From 24ef423d2970c8c7f10c8b0bea763b223ef24d54 Mon Sep 17 00:00:00 2001 From: reshamas Date: Tue, 31 Jan 2023 14:07:48 -0500 Subject: [PATCH 01/14] add instructions page for translations --- contributing/language-translations.md | 41 +++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 contributing/language-translations.md diff --git a/contributing/language-translations.md b/contributing/language-translations.md new file mode 100644 index 0000000..1e390fe --- /dev/null +++ b/contributing/language-translations.md @@ -0,0 +1,41 @@ +(translations)= +# Language Translations + +## Requirements +- GitHub account +- Knowledge of English and (Spanish or Portuguese) + +## About +We are using [Transifex](https://www.transifex.com/) to manage the language translations, which provides a tranlsation infrastructure with Sphinx. Transifex is *a global content repository with a REST API, SDKs, automation, and more so you can centrally manage your source content and translations and build amazing multilingual digital experiences for your users.* + +## Workflow + +1. Create a [Transifex account](https://www.transifex.com/signin/). + +Note: You can use your GitHub account to authenticate and log in to Transifex. + +2. Navigate to our project website: [pymc/data-umbrella-sprints-website](https://www.transifex.com/pymc/data-umbrella-sprints-website/) + +3. Click on "Editor" in the top menu which will bring you to a list of pages of the website to translate: https://www.transifex.com/pymc/data-umbrella-sprints-website/translate/ + +4. In the top menu, choose "Select a language". Current options are: + - Portuguese (pt) + - Spanish (es) + +5. Pages to translate is a sub-menu under "Editor." Currently, these pages are being prioritized for translation: [priority pages](https://github.com/pymc-devs/pymc-data-umbrella/issues/99). + +6. You can translate sub-sections and "Save translation." + +:::{tip} +GitHub Actions is configued on this repository. Once per week, it will automatically accept the translations. +::: + +## Translating content: volunteers needed 🙌 + +:::{note} +If you would to volunteer for translations, please select a page on [Issue #99](https://github.com/pymc-devs/pymc-data-umbrella/issues/99) on GitHub and indicate which page you will translate. A comment can be added to the issue. This will let other contributors know so that work is not duplicated. +::: + +## Thank you 🙌 + +Thank you for your contributions and making this website accessible to more users. From fabd558dc634746551ef489f9a561bb80c850498 Mon Sep 17 00:00:00 2001 From: reshamas Date: Tue, 31 Jan 2023 14:20:52 -0500 Subject: [PATCH 02/14] add translations pg to index file --- contributing/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/contributing/index.md b/contributing/index.md index 81d1b89..03d9649 100644 --- a/contributing/index.md +++ b/contributing/index.md @@ -10,6 +10,7 @@ self ../about/contributing_to_documentation/index donate ../2022-07_sprint/sprint_parties/media_kit +language-translations ::: ## Help us improve this website From 07196817a475fefdda1ae5704cc7b1572d1fb1ce Mon Sep 17 00:00:00 2001 From: reshamas Date: Tue, 31 Jan 2023 14:29:35 -0500 Subject: [PATCH 03/14] minor fixes; example translation PR --- contributing/language-translations.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/contributing/language-translations.md b/contributing/language-translations.md index 1e390fe..427638a 100644 --- a/contributing/language-translations.md +++ b/contributing/language-translations.md @@ -18,24 +18,24 @@ Note: You can use your GitHub account to authenticate and log in to Transifex. 3. Click on "Editor" in the top menu which will bring you to a list of pages of the website to translate: https://www.transifex.com/pymc/data-umbrella-sprints-website/translate/ -4. In the top menu, choose "Select a language". Current options are: +4. In the top menu, choose "Select a language". Current options are: - Portuguese (pt) - Spanish (es) -5. Pages to translate is a sub-menu under "Editor." Currently, these pages are being prioritized for translation: [priority pages](https://github.com/pymc-devs/pymc-data-umbrella/issues/99). +5. Pages to translate is a sub-menu under "Editor." Currently, these pages are being prioritized for translation: [priority pages](https://github.com/pymc-devs/pymc-data-umbrella/issues/99) 6. You can translate sub-sections and "Save translation." -:::{tip} -GitHub Actions is configued on this repository. Once per week, it will automatically accept the translations. +:::{note} +There is a GitHub Actions that is configured on this repository, which turns a translation into a pull request whih is submitted to the repository. [PR #166](https://github.com/pymc-devs/pymc-data-umbrella/pull/166/files) is an example pull request. ::: ## Translating content: volunteers needed 🙌 :::{note} -If you would to volunteer for translations, please select a page on [Issue #99](https://github.com/pymc-devs/pymc-data-umbrella/issues/99) on GitHub and indicate which page you will translate. A comment can be added to the issue. This will let other contributors know so that work is not duplicated. +If you would to volunteer for translations, please select a page on [Issue #99](https://github.com/pymc-devs/pymc-data-umbrella/issues/99) on GitHub and indicate which page you will translate. A comment can be added to the issue. This will let other contributors know so that work is not duplicated. ::: ## Thank you 🙌 -Thank you for your contributions and making this website accessible to more users. +Thank you for your contributions and making this website accessible to more users. From db01f785c62d0c8067c555001042e3bbc68a0784 Mon Sep 17 00:00:00 2001 From: reshamas Date: Tue, 31 Jan 2023 14:33:11 -0500 Subject: [PATCH 04/14] update index page; update translations call for volunteers --- contributing/index.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/contributing/index.md b/contributing/index.md index 03d9649..705b6f5 100644 --- a/contributing/index.md +++ b/contributing/index.md @@ -71,8 +71,7 @@ There are social media links and text available in our {ref}`media_kit` with inf ## Translating content: volunteers needed 🙌 -:::{note} -We first need to set up the translation infrastructure with sphinx. If you know how to do it or are interested in translating, please reach out. +We are translating the website from English to other languages. The first couple of languages we are focusing on are Spanish and Portuguese: {ref}`translations` + +If you are interested in translating to another language, please open up an [issue](https://github.com/pymc-devs/pymc-data-umbrella/issues) with any suggestions. -In the meantime, if you would to volunteer for translations, please add your information to [Issue #99](https://github.com/pymc-devs/pymc-data-umbrella/issues/99) on GitHub. We will be in touch when we are ready to move forward on this project. -::: From 23997221ad03830b646c916561f20031bd7fa461 Mon Sep 17 00:00:00 2001 From: reshamas Date: Tue, 31 Jan 2023 14:35:18 -0500 Subject: [PATCH 05/14] rm extra emoji --- contributing/language-translations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/language-translations.md b/contributing/language-translations.md index 427638a..466cd7c 100644 --- a/contributing/language-translations.md +++ b/contributing/language-translations.md @@ -30,7 +30,7 @@ Note: You can use your GitHub account to authenticate and log in to Transifex. There is a GitHub Actions that is configured on this repository, which turns a translation into a pull request whih is submitted to the repository. [PR #166](https://github.com/pymc-devs/pymc-data-umbrella/pull/166/files) is an example pull request. ::: -## Translating content: volunteers needed 🙌 +## Translating content: volunteers needed :::{note} If you would to volunteer for translations, please select a page on [Issue #99](https://github.com/pymc-devs/pymc-data-umbrella/issues/99) on GitHub and indicate which page you will translate. A comment can be added to the issue. This will let other contributors know so that work is not duplicated. From aa920480e6338aaecc3f9f50faab46e8b6b5a1fc Mon Sep 17 00:00:00 2001 From: reshamas Date: Tue, 31 Jan 2023 14:37:26 -0500 Subject: [PATCH 06/14] spellling; rm extra note --- contributing/language-translations.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/contributing/language-translations.md b/contributing/language-translations.md index 466cd7c..869b6c4 100644 --- a/contributing/language-translations.md +++ b/contributing/language-translations.md @@ -27,14 +27,13 @@ Note: You can use your GitHub account to authenticate and log in to Transifex. 6. You can translate sub-sections and "Save translation." :::{note} -There is a GitHub Actions that is configured on this repository, which turns a translation into a pull request whih is submitted to the repository. [PR #166](https://github.com/pymc-devs/pymc-data-umbrella/pull/166/files) is an example pull request. +There is a GitHub Actions that is configured on this repository, which turns a translation into a pull request which is submitted to the repository. [PR #166](https://github.com/pymc-devs/pymc-data-umbrella/pull/166/files) is an example pull request. ::: ## Translating content: volunteers needed -:::{note} If you would to volunteer for translations, please select a page on [Issue #99](https://github.com/pymc-devs/pymc-data-umbrella/issues/99) on GitHub and indicate which page you will translate. A comment can be added to the issue. This will let other contributors know so that work is not duplicated. -::: + ## Thank you 🙌 From fc2021c6b66bbed94eb3eff9735076cbacc117bf Mon Sep 17 00:00:00 2001 From: reshamas Date: Tue, 31 Jan 2023 14:40:14 -0500 Subject: [PATCH 07/14] streamline contributing categories --- contributing/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/index.md b/contributing/index.md index 705b6f5..d2d23c2 100644 --- a/contributing/index.md +++ b/contributing/index.md @@ -69,7 +69,7 @@ There are social media links and text available in our {ref}`media_kit` with inf to avoid "tutorials" as it can be confusing with the content of the documentation webinar. If you need some alternative to "webinar" consider using "event" or "workshop" before for example. -## Translating content: volunteers needed 🙌 +## Language translations We are translating the website from English to other languages. The first couple of languages we are focusing on are Spanish and Portuguese: {ref}`translations` From d089c0bebe8c387e95ac6f0a1d7f53fa735f89bc Mon Sep 17 00:00:00 2001 From: reshamas Date: Tue, 31 Jan 2023 14:44:20 -0500 Subject: [PATCH 08/14] polish text --- contributing/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/index.md b/contributing/index.md index d2d23c2..93a5696 100644 --- a/contributing/index.md +++ b/contributing/index.md @@ -71,7 +71,7 @@ There are social media links and text available in our {ref}`media_kit` with inf ## Language translations -We are translating the website from English to other languages. The first couple of languages we are focusing on are Spanish and Portuguese: {ref}`translations` +We are translating the website from English to other languages. The first couple of languages we are focusing on are Spanish and Portuguese. For more detailed instructions on how you can submit translations, see {ref}`translations`. If you are interested in translating to another language, please open up an [issue](https://github.com/pymc-devs/pymc-data-umbrella/issues) with any suggestions. From b9ef6c959b078186ba712015f0ecda6ff1284a01 Mon Sep 17 00:00:00 2001 From: reshamas Date: Tue, 31 Jan 2023 14:51:16 -0500 Subject: [PATCH 09/14] spelling --- contributing/index.md | 3 +-- contributing/language-translations.md | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/contributing/index.md b/contributing/index.md index 93a5696..2250a18 100644 --- a/contributing/index.md +++ b/contributing/index.md @@ -17,7 +17,7 @@ language-translations If you find any errors or have any suggestions, please let us know! You can either [report an issue](https://github.com/pymc-devs/pymc-data-umbrella/issues/new) or send us a pull request. -1. Click in the GitHub icon in the top right corner of the page to visit the page repo. +1. Click on the GitHub icon in the top right corner of the page to visit the page repo. 2. Fork and clone the repository. @@ -74,4 +74,3 @@ There are social media links and text available in our {ref}`media_kit` with inf We are translating the website from English to other languages. The first couple of languages we are focusing on are Spanish and Portuguese. For more detailed instructions on how you can submit translations, see {ref}`translations`. If you are interested in translating to another language, please open up an [issue](https://github.com/pymc-devs/pymc-data-umbrella/issues) with any suggestions. - diff --git a/contributing/language-translations.md b/contributing/language-translations.md index 869b6c4..9ea614b 100644 --- a/contributing/language-translations.md +++ b/contributing/language-translations.md @@ -6,7 +6,7 @@ - Knowledge of English and (Spanish or Portuguese) ## About -We are using [Transifex](https://www.transifex.com/) to manage the language translations, which provides a tranlsation infrastructure with Sphinx. Transifex is *a global content repository with a REST API, SDKs, automation, and more so you can centrally manage your source content and translations and build amazing multilingual digital experiences for your users.* +We are using [Transifex](https://www.transifex.com/) to manage the language translations, which provides a translation infrastructure with Sphinx. Transifex is *a global content repository with a REST API, SDKs, automation, and more so you can centrally manage your source content and translations and build amazing multilingual digital experiences for your users.* ## Workflow From 28cb6da43b2aa3de8c86f75ddb2094ebb6b74188 Mon Sep 17 00:00:00 2001 From: reshamas Date: Tue, 31 Jan 2023 15:03:11 -0500 Subject: [PATCH 10/14] add video timestamps to contributing --- contributing/index.md | 1 + contributing/videos.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 contributing/videos.md diff --git a/contributing/index.md b/contributing/index.md index 2250a18..2812616 100644 --- a/contributing/index.md +++ b/contributing/index.md @@ -6,6 +6,7 @@ :hidden: self +videos ../about/contributing_to_pymc/index ../about/contributing_to_documentation/index donate diff --git a/contributing/videos.md b/contributing/videos.md new file mode 100644 index 0000000..275cdb9 --- /dev/null +++ b/contributing/videos.md @@ -0,0 +1,18 @@ +(videos)= +# Contribute timestamps to videos + +## Requirements +- GitHub account +- Markdown + +## About: why we are adding timestamps + +We have a collection of videos on YouTube from PyMCon 2020 and PyMCon Web Series. + +:stopwatch: We are adding timestamps to the PyMC YouTube videos. When timestamps are available: +1. It makes it easy for viewers to get to the part in the video they are interested in. +2. It also helps potential viewers find the video based on their search terms. + +## Workflow + +Complete instructions are available in [Issue 11: adding timestamps to videos](https://github.com/pymc-devs/video-timestamps/issues/11). From 290b36f8efa05f23154018e4353ea9a32258137b Mon Sep 17 00:00:00 2001 From: reshamas Date: Tue, 31 Jan 2023 19:22:11 -0500 Subject: [PATCH 11/14] fix grammar --- contributing/language-translations.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/contributing/language-translations.md b/contributing/language-translations.md index 9ea614b..f0afdfa 100644 --- a/contributing/language-translations.md +++ b/contributing/language-translations.md @@ -3,16 +3,15 @@ ## Requirements - GitHub account -- Knowledge of English and (Spanish or Portuguese) +- Knowledge of English +- Knowledge of Spanish or Portuguese ## About We are using [Transifex](https://www.transifex.com/) to manage the language translations, which provides a translation infrastructure with Sphinx. Transifex is *a global content repository with a REST API, SDKs, automation, and more so you can centrally manage your source content and translations and build amazing multilingual digital experiences for your users.* ## Workflow -1. Create a [Transifex account](https://www.transifex.com/signin/). - -Note: You can use your GitHub account to authenticate and log in to Transifex. +1. Create a [Transifex account](https://www.transifex.com/signin/). Note: You can use your GitHub account to authenticate and log in to Transifex. 2. Navigate to our project website: [pymc/data-umbrella-sprints-website](https://www.transifex.com/pymc/data-umbrella-sprints-website/) @@ -24,16 +23,15 @@ Note: You can use your GitHub account to authenticate and log in to Transifex. 5. Pages to translate is a sub-menu under "Editor." Currently, these pages are being prioritized for translation: [priority pages](https://github.com/pymc-devs/pymc-data-umbrella/issues/99) -6. You can translate sub-sections and "Save translation." +6. You can translate sub-sections and select "Save translation." :::{note} -There is a GitHub Actions that is configured on this repository, which turns a translation into a pull request which is submitted to the repository. [PR #166](https://github.com/pymc-devs/pymc-data-umbrella/pull/166/files) is an example pull request. +There is GitHub Actions that is configured on this repository, which turns a translation into a pull request which is submitted to the repository. [PR #166](https://github.com/pymc-devs/pymc-data-umbrella/pull/166/files) is an example pull request. ::: ## Translating content: volunteers needed -If you would to volunteer for translations, please select a page on [Issue #99](https://github.com/pymc-devs/pymc-data-umbrella/issues/99) on GitHub and indicate which page you will translate. A comment can be added to the issue. This will let other contributors know so that work is not duplicated. - +If you would like to volunteer for translations, please select a page on [Issue #99](https://github.com/pymc-devs/pymc-data-umbrella/issues/99) on GitHub and indicate which page you will translate. A comment can be added to the issue. This will let other contributors know so that work is not duplicated. ## Thank you 🙌 From 9d8cfdef60b726d5192ad533e08ee805b2b5e2bb Mon Sep 17 00:00:00 2001 From: Reshama Shaikh Date: Wed, 1 Feb 2023 07:49:50 -0500 Subject: [PATCH 12/14] add transifex for requirement Co-authored-by: Oriol Abril-Pla --- contributing/language-translations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/language-translations.md b/contributing/language-translations.md index f0afdfa..709ab42 100644 --- a/contributing/language-translations.md +++ b/contributing/language-translations.md @@ -2,7 +2,7 @@ # Language Translations ## Requirements -- GitHub account +- Transifex account (or GitHub one to log in with it) - Knowledge of English - Knowledge of Spanish or Portuguese From f7991be86036f8f49556bed371f0ed207f34eebc Mon Sep 17 00:00:00 2001 From: Reshama Shaikh Date: Wed, 1 Feb 2023 07:51:52 -0500 Subject: [PATCH 13/14] Update contributing/language-translations.md --- contributing/language-translations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/language-translations.md b/contributing/language-translations.md index 709ab42..4a224a2 100644 --- a/contributing/language-translations.md +++ b/contributing/language-translations.md @@ -31,7 +31,7 @@ There is GitHub Actions that is configured on this repository, which turns a tra ## Translating content: volunteers needed -If you would like to volunteer for translations, please select a page on [Issue #99](https://github.com/pymc-devs/pymc-data-umbrella/issues/99) on GitHub and indicate which page you will translate. A comment can be added to the issue. This will let other contributors know so that work is not duplicated. +If you would like to volunteer for translations, please select a page. We have included a list of priority pages to translate on [Issue #99](https://github.com/pymc-devs/pymc-data-umbrella/issues/99). ## Thank you 🙌 From dbd35c408d1bdad22abf168bad90b9d79c506949 Mon Sep 17 00:00:00 2001 From: Reshama Shaikh Date: Wed, 1 Feb 2023 07:52:19 -0500 Subject: [PATCH 14/14] remove stopwatch emoji --- contributing/videos.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributing/videos.md b/contributing/videos.md index 275cdb9..0d455d1 100644 --- a/contributing/videos.md +++ b/contributing/videos.md @@ -9,7 +9,7 @@ We have a collection of videos on YouTube from PyMCon 2020 and PyMCon Web Series. -:stopwatch: We are adding timestamps to the PyMC YouTube videos. When timestamps are available: +We are adding timestamps to the PyMC YouTube videos. When timestamps are available: 1. It makes it easy for viewers to get to the part in the video they are interested in. 2. It also helps potential viewers find the video based on their search terms.