-
Notifications
You must be signed in to change notification settings - Fork 54
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
Translation guidelines intro #832
Open
yabellini
wants to merge
3
commits into
main
Choose a base branch
from
translation-guidelines-intro
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
title: "Introducing the rOpenSci Localization and Translation Guidelines" | ||
author: | ||
- Yanina Bellini Saibene | ||
- Maëlle Salmon | ||
- Paola Corrales | ||
- Elio Campitelli | ||
editor: | ||
- Steffi LaZerte | ||
date: '2024-09-10' | ||
slug: localization-guide | ||
categories: | ||
- blog | ||
tags: | ||
- multilingual | ||
- Community | ||
|
||
description: "" | ||
|
||
--- | ||
|
||
Since 2022, rOpenSci has been developing tools and processes to localize and translate our content. | ||
As a result of this effort, we created a set of guidelines to assist our community in translating and localizing our resources. | ||
|
||
We're excited to introduce the first version of the rOpenSci Localization and Translation Guidelines. | ||
|
||
These guidelines explain the rationale behind and the process for localizing and translating our resources. | ||
They are designed to support community members contributing to the [multilingual publishing project](https://ropensci.org/multilingual-publishing/). | ||
|
||
This guide is multilingual, offering both general and specific guidelines for translating and localizing our resources across all [active languages](https://github.com/ropensci-review-tools/translation_guide/?tab=readme-ov-file#languages-with-active-projects). | ||
|
||
|
||
|
||
## Overview | ||
|
||
The guide consists of six sections: | ||
|
||
1. [Preface](https://translationguide.ropensci.org): A brief overview of the book's purpose, intended audience, the goals of the guidelines, and instructions on how to contribute. | ||
|
||
2. [Motivation](https://translationguide.ropensci.org/motivation.html): This section explains the importance of localizing and translating our resources. | ||
It discusses the impact of language barriers, the principles of community-driven localization and translation, and how these activities contribute to community building. | ||
|
||
3. [General Guidelines](https://translationguide.ropensci.org/intro.html): This section introduces the concepts of localization and translation, explaining how they enhance accessibility. | ||
It also outlines the technical infrastructure, work organization, and general aspects of the translation process. | ||
|
||
4. [Translation and Review Guidelines](https://translationguide.ropensci.org/howtoreview.html): This section offers a detailed guide on translating and reviewing our resources. | ||
It covers how to contribute to a new or existing language project and manage the localization and translation process. | ||
It also provides technical and general review guidelines to ensure translation quality. | ||
|
||
5. [Specific Guidelines](https://translationguide.ropensci.org/specific_guidelines.html): This chapter has specific content for each language. | ||
It contains specific guidelines for localizing and translating content based on community agreements. | ||
For instance, the rules defined by the Spanish-speaking community may differ from those of the English-speaking community. | ||
This section also addresses the localization of citations, code, diagrams, and data, and includes a glossary. | ||
|
||
6. [NEWS](https://translationguide.ropensci.org/booknews.html): This section documents all changes made to the guidelines in each version. | ||
|
||
|
||
## Next steps | ||
|
||
This guide is designed for those interested in localizing rOpenSci materials or contributing to the maintenance of localized content. | ||
It is also useful for anyone tasked with localizing material for another community or group. We hope that our processes, agreements, and lessons learned can benefit other communities as well. | ||
|
||
The guide is available in English and Spanish, with plans to translate it into other languages based on our active translation projects, like Portuguese. | ||
|
||
If you'd like to contribute to translation efforts or improve this guide, please check out the [list of languages for which there are active translation projects and their statuses](https://github.com/ropensci-review-tools/translation_guide#active). | ||
|
||
You can contact us at [email protected] or [open an issue in this repository](https://github.com/ropensci-review-tools/translation_guide/issues). | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
right before publishing the post would be a good time for a GitHub and Zenodo release 😉
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes!