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 French translation #5

Open
14 of 23 tasks
vlevieux opened this issue Jul 1, 2021 · 5 comments
Open
14 of 23 tasks

Add French translation #5

vlevieux opened this issue Jul 1, 2021 · 5 comments
Labels

Comments

@vlevieux
Copy link

vlevieux commented Jul 1, 2021

Language:

Initial tasks

  • Create an empty repository on GitHub. Name the repository as flask-docs-<lang code>, for example, flask-docs-es.
  • Set up your repository based on the translation template repository:
$ git clone https://github.com/flaskcwg/translation-template.git flask-docs-<lang code>
$ cd flask-docs-<lang code>
$ git remote set-url origin <the-Git-URL-to-your-repository>
$ git remote add upstream https://github.com/pallets/flask.git
$ git fetch upstream
$ git merge upstream/2.0.x
$ git push -u origin main
  • Create a virtual environment, then install the requirements:
$ python -m pip install --upgrade pip setuptools
$ pip install -r requirements/dev.txt
$ pip install sphinx-intl
$ pip install -e .
$ pre-commit install
  • Generate the .pot and .po files (replace <lang code> with your language code):
$ cd docs
$ make gettext  # use ".\make.bat gettext" on Windows
$ sphinx-intl update -p _build/gettext -l <lang code>
  • Replace the <LANG> in the README.md, the language config, and the
    html_search_language config in docs/conf.py with your language code.
    Update the .po file examples.
  • Setup ReadtheDocs to connect your repository, use flask-<lang code> as the subdomain, set the default version to the main branch, and enable the "single version" mode.
  • Translate the README.md and the pull request template (optional).
  • Update the title, and all the <UPDATE THIS> placeholders in README.md and docs/conf.py. You can update the README.md to add more format or translate tips for your language.
  • You can choose to use Transifex or other translation platforms. In that case, you will need to rewrite the "Contributing Guide" in the README.md.
  • Update the Language-Team value in all .po files.
  • Translate html_title and project links in the docs/conf.py file.
  • Translate the docs/index file (you can make a localized logo for the index page).
  • Translate the docs/foreword file.
  • Translate the docs/advanced-foreword file.
  • Translate the docs/installation file.
  • [x ] Translate the docs/quickstart file.
  • Translate the "Tutorial" part of the docs.
  • Switch the repository into the flaskcwg organization.

Public

Tasks after the repository is switched into flaskcwg:

Maintenance

Tasks when the whole documentation is translated:

  • Create a 2.0.x branch, set it as default version on ReadtheDocs.
  • Rewrite the contributing guide in the README.md of the translation repository, encourage people to fetch upstream and update docs (see details below).
  • Rename the section "Translation To-do List" to "Translators". You can also add
    a "Reviewers" section.
  • Switch the docs into http://flask.palletsprojects.com/.

You should sync documentation updates from Flask periodically:

$ git fetch upstream
$ git merge upstream/2.0.x
$ cd docs
$ make gettext  # use ".\make.bat gettext" on Windows
$ sphinx-intl update -p _build/gettext

Then update the translation for new changes.

@Abdur-rahmaanJ
Copy link
Member

@Jalkhov can you follow the issue about migration. Adding you @vlevieux as the french coordinator!

@Jalkhov
Copy link
Member

Jalkhov commented Jul 29, 2021

@vlevieux Do you have discord?

Migrate repo to FlaskCWG

@vlevieux
Copy link
Author

vlevieux commented Aug 4, 2021

@Jalkhov Yes I do, I already joined the Pallets Projects discord. My ID: @reese41#6396

@vlevieux
Copy link
Author

vlevieux commented Aug 4, 2021

@Abdur-rahmaanJ @Jalkhov Unfortunately I can't transfer the ownership to flaskcwg. I don't have the permissions to create a public repo on flaskcwg.

@Abdur-rahmaanJ
Copy link
Member

@vlevieux Now supposed to be ok. Privileges granted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants