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

Make website/documentation translatable #1710

Open
drkameleon opened this issue Sep 17, 2024 · 0 comments
Open

Make website/documentation translatable #1710

drkameleon opened this issue Sep 17, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request open discussion Open discussion about features/ideas/suggestions website Issues related to the website

Comments

@drkameleon
Copy link
Collaborator

drkameleon commented Sep 17, 2024

The subject of translating the website or part of it is sth has popped up more than a couple of times.

Personally, I would be absolutely in favor of that.

The challenge here is to split the material in parts, so that a translator/maintainer can work just with the translations, without having to deal with code, while keeping the whole thing manageable (and secure from vast variations, from one version to another, or in case sth slightly changes, e.g. in our standard library)

Also, we should set some guidelines and start setting priorities. Obviously, there are languages that could be given higher priority, for reasons of relevance, number of speakers, etc. (I, for instance, am a Greek native speaker, but I don't think anybody will care that much; now, say Spanish, Mandarin, I don't know... obviously, I would consider that a higher priority). In that, we should also consider if there is enough time/people to maintain these translations (e.g. adding a translation in You-name-it and being stuck with it in our very next release doesn't make any sense - so obviously commitment of the maintainers of the translations will be important! :) )


A way (just a way I would think right now) in which the translatable material could be structured:

  • Library
    • Description of a module
    • Function
      • Description
      • Options
        • Description
  • Sections
    • Home
    • Getting Started
    • In A Nutshell (obviously just the intros, not everything)
    • Language (this could be broken into more identifiable parts!)
    • Command Line
    • Library
  • Homepage (in case we decide to translate the whole website, which - if we go that far - "why not?!")
    • The different text sections of the page

Deep breath. If you are lost, it's ok.
Again: just brainstorming in written form, without necessarilymaking much sense...

But... as they say: "algo es algo" lol. 🚀

@drkameleon drkameleon added documentation Improvements or additions to documentation enhancement New feature or request open discussion Open discussion about features/ideas/suggestions labels Sep 17, 2024
@drkameleon drkameleon self-assigned this Sep 17, 2024
@drkameleon drkameleon added the website Issues related to the website label Sep 17, 2024
@drkameleon drkameleon pinned this issue Sep 17, 2024
@drkameleon drkameleon changed the title Make documentation translatable Make website/documentation translatable Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request open discussion Open discussion about features/ideas/suggestions website Issues related to the website
Projects
None yet
Development

No branches or pull requests

1 participant