search

probcomp / Gen.jl

A general-purpose probabilistic programming system with programmable inference
https://gen.dev
Apache License 2.0
1.8k stars 160 forks source link

Translation [PT-BR] - Tutorials, repository etc #147

Open ghost opened 4 years ago

ghost commented 4 years ago

Hello Everyone

I'd like to know if it is ok to localise the tutorials or the repository for Brazilian Portuguese. I started doing some drafts.

marcoct commented 4 years ago

HI @pdpl. Thanks for your interest in Gen, and your offer to localize it for Brazilian Portuguese!

Translating the tutorials is great, with the caveat that Gen is still rapidly evolving research software, so they might become out of date quickly unless actively maintained. Therefore, we'd like to include the version number of Gen (see https://github.com/probcomp/Gen/releases) with which they work, and a link to the corresponding version of the documentation (e.g. https://probcomp.github.io/Gen/v0.3.1/) at the top of each translated tutorial.

The tutorials are Jupyter notebooks located at https://github.com/probcomp/gen-quickstart. The Gen website also contains versions of some of these rendered as Markdown files (https://probcomp.github.io/Gen/tutorials.html). There are two options for translating --- translating the source Jupyter notebooks themselves and rendering new Markdown files for the web site, or translating just the rendered Markdown for the website.

Translating both the Jupyter notebooks and the Markdown would involve, roughly:

  1. Translate the tutorial Jupyter notebook itself, and make a PR at https://github.com/probcomp/gen-quickstart containing the new notebook (we can create en/, pt-br/ directories for the versions of the notebooks in various languages).
  2. Generate a rendered version of each notebook by (a) running it so all plots and output appear, (b) Saving as Markdown in Jupyter. This should produce a directory containing a Markdown file and the PNGs for various plots.
  3. Making a PR to https://github.com/probcomp/Gen, to branch gh-pages that adds the directory containing the translated Markdown and plots (like https://github.com/probcomp/Gen/tree/gh-pages/intro-to-modeling). We can create language-specific directories for the tutorials, so they are stored at e.g. https://github.com/probcomp/Gen/tree/gh-pages/en/intro-to-modeling, etc.).
  4. Creating a copy of the Gen Tutorials page (https://github.com/probcomp/Gen/blob/gh-pages/tutorials.md) for each new language, which links to each translated tutorial.

Just translating the Markdown versions of the tutorials would just involve (3.) and (4.).

Thanks again for your interest and offer to make Gen more accessible!

ghost commented 4 years ago

Hello @marcoct , thank you for your reply. Don't worry about the need of reworking the translation everytime the version changes.

I'll start following these guidelines from now on. If you have any question, please, get in touch anytime.

ghost commented 4 years ago

@marcoct , hope you are doing well.

I changed my Github account and I'd like to know if I can still localize the Jupyter Notebooks. Has someone already started ? My last username is @pdpl , soon I'll delete this account.