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

🌍Call for translators in GeoVista official document🌍 #957

Open
tkoyama010 opened this issue Jul 3, 2024 · 8 comments
Open

🌍Call for translators in GeoVista official document🌍 #957

tkoyama010 opened this issue Jul 3, 2024 · 8 comments
Labels
good first issue A good issue to take on if you're just getting started with geovista development new: documentation Highlight a new community raised "documentation" issue scipy 2024 type: documentation Auto-labelled for doc/* and docs/* branches

Comments

@tkoyama010
Copy link
Collaborator

tkoyama010 commented Jul 3, 2024

If you've ever wanted to contribute and help the cause of open source, now is your chance. We need you!

GeoVista official documentation translations is a project to provide GeoVista official documentation, hosted on
the Read The Docs platform, in multiple languages.

Note

The current procedure is bit tricky because Read The Docs doesn't have a way to specify options for sphinx-build command. conf.py files for each languages have language and locale_dirs values without having full copy of conf.py of GeoVista doc. If we want to specify conf.py file that is out of source directory, we will use -c option for the sphinx-build command. Unfortunately Read the Docs doesn't support that. If there is a better way, open an issue.

How the translated documentation projects are setup on RTD

Instructions:
https://docs.readthedocs.org/en/latest/localization.html#project-with-multiple-translations

Key points:

  • There is a RTD project for each language.
  • Each project needs the correct Language setting on the
    Settings page.
  • The parent project needs connections created to each translated
    project on the Translations Settings page.
Language Build Status RTD Project Transifex
English (parent project) Documentation Status readthedocs.org
日本語 Documentation Status readthedocs.org Transifex

Caution

The author of this proposal agrees with "Flags are not languages", so no flag emoji will be used.

@tkoyama010 tkoyama010 added new: documentation Highlight a new community raised "documentation" issue type: documentation Auto-labelled for doc/* and docs/* branches labels Jul 3, 2024
@tkoyama010
Copy link
Collaborator Author

@all-contributors Please add @tkoyama010 for translation

Copy link
Contributor

@tkoyama010

I've put up a pull request to add @tkoyama010! 🎉

@tkoyama010 tkoyama010 pinned this issue Jul 3, 2024
@tkoyama010
Copy link
Collaborator Author

@bjlittle I can setup Japanese translated documentation on RTD. Please add me maintainer on readthedocs.org .

@bjlittle
Copy link
Owner

bjlittle commented Jul 3, 2024

@tkoyama010 I've just sent you an invite to be a maintainer on RTD 👍

@tkoyama010
Copy link
Collaborator Author

@bjlittle Thanks a lot!
image

@trexfeathers
Copy link
Collaborator

@tkoyama010 お見事

I love it! 👏💐

@tkoyama010 tkoyama010 changed the title Call for translators in GeoVista official documentation translations 🌍Call for translators in GeoVista official documentation translations🌍 Jul 3, 2024
@tkoyama010 tkoyama010 changed the title 🌍Call for translators in GeoVista official documentation translations🌍 🌍Call for translators in GeoVista official document🌍 Jul 3, 2024
@tkoyama010 tkoyama010 added scipy 2024 good first issue A good issue to take on if you're just getting started with geovista development labels Jul 5, 2024
@tkoyama010
Copy link
Collaborator Author

tkoyama010 commented Jul 30, 2024

Added that the translation work is following PEP 545 – Python Documentation Translations.

@tkoyama010
Copy link
Collaborator Author

tkoyama010 commented Jul 30, 2024

Added an explanation not to use the flag emoji in this proposal because @tkoyama010 agree with the “Flags are not languages”.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue A good issue to take on if you're just getting started with geovista development new: documentation Highlight a new community raised "documentation" issue scipy 2024 type: documentation Auto-labelled for doc/* and docs/* branches
Projects
None yet
Development

No branches or pull requests

3 participants