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 Translations to the Documentation #50

Open
koladev32 opened this issue Sep 23, 2023 · 0 comments
Open

Add Translations to the Documentation #50

koladev32 opened this issue Sep 23, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@koladev32
Copy link
Owner

Is your feature request related to a problem? Please describe.

As the Django REST Framework Simple API Key gains traction, we recognize that our documentation may not be accessible to all developers worldwide due to language barriers. Considering that Django and Python have a vast global user base, we're missing out on reaching a significant portion of the developer community.

Describe the solution you'd like

We propose to provide translations of our documentation into key languages to make it more inclusive and accessible. Initially, we could target the following languages, given the broad reach of Django and Python:

  • Spanish
  • French

Additionally, we can leverage platforms like Read the Docs that support multi-language documentation to facilitate this.

Describe alternatives you've considered

One alternative could be to provide only key sections of the documentation in multiple languages, instead of the entire documentation. This might be easier to maintain and update. However, this might not give non-English-speaking users the full experience.

Another alternative is to use automated translation tools or plugins, but these often lack the nuance and accuracy of human translations, especially for technical content.

Additional context

Engaging the Django and Python communities for translation contributions can serve a dual purpose: ensuring accuracy in translations and deepening community involvement. A community-driven approach can be both effective and beneficial in strengthening ties with users worldwide.

@koladev32 koladev32 added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Sep 23, 2023
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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant