Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add instructions page for translations #175

Merged
merged 14 commits into from
Feb 1, 2023
12 changes: 6 additions & 6 deletions contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,19 @@
:hidden:

self
videos
../about/contributing_to_pymc/index
../about/contributing_to_documentation/index
donate
../2022-07_sprint/sprint_parties/media_kit
language-translations
:::

## Help us improve this website

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.

Expand Down Expand Up @@ -68,10 +70,8 @@ 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

:::{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. For more detailed instructions on how you can submit translations, see {ref}`translations`.

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.
:::
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.
38 changes: 38 additions & 0 deletions contributing/language-translations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
(translations)=
# Language Translations

## Requirements
- Transifex account (or GitHub one to log in with it)
- 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.

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 select "Save translation."

:::{note}
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 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 🙌

Thank you for your contributions and making this website accessible to more users.
18 changes: 18 additions & 0 deletions contributing/videos.md
Original file line number Diff line number Diff line change
@@ -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:
reshamas marked this conversation as resolved.
Show resolved Hide resolved
reshamas marked this conversation as resolved.
Show resolved Hide resolved
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).