Merge pull request #574 from julian-molina/develop

Contribution: Languages
This commit is contained in:
Julian Molina authored and GitHub committed 2021-02-20 13:59:08 +01:00
commit 8d2f6e11d0
7 files changed
+182 -36

No files matched your search

@@ -0,0 +1,100 @@
{
"topic": "Contributing to Superalgos",
"pageNumber": "4",
"type": "How to Contribute Translations",
"definition": {
"text": "The Docs are originally written in English. Making Superalgos more accessible is a key endeavor to grow the Community and the user base. Translating tutorials and software documentation into languages other than English is of huge value!",
"updated": 1613822257340
},
"paragraphs": [
{
"style": "Title",
"text": "Read About Contributing to the Docs",
"updated": 1613822300139
},
{
"style": "Text",
"text": "Translations are a particular case of contributing to the Docs. Please read the How to Contribute to the Docs page first, and come back here for the details about how we deal with translations in particular.",
"updated": 1613822394353
},
{
"style": "Title",
"text": "About Translations",
"updated": 1613822457097
},
{
"style": "Note",
"text": "Before you being, please read the page Docs In English.",
"updated": 1613822688747
},
{
"style": "Text",
"text": "The system stores the content of each Docs Page in a single file, regardless of how many translations may exist for each page.",
"updated": 1613822896070
},
{
"style": "Text",
"text": "Actually, translations exist at the level of each paragraph. This means that, for each paragraph in a page, there may be as many translations as there are supported languages.",
"updated": 1613825539396
},
{
"style": "Success",
"text": "The above doesn't affect your work directly, but it is worth noting because it means that many contributors may be working on the same page at any point in time. Hence the need to constantly update and to submit contributions frequently.",
"updated": 1613823174025
},
{
"style": "Title",
"text": "Best Practices",
"updated": 1613824072677
},
{
"style": "Text",
"text": "As explained in the How to Contribute to the Docs page, you must switch to the develop branch and make sure your system is up to date.",
"updated": 1613825583367
},
{
"style": "List",
"text": "Then, switch to the language you wish to translate to."
},
{
"style": "List",
"text": "To translate a paragraph, right-click to edit the content and replace the English text with your translation. That's it!",
"updated": 1613825599051
},
{
"style": "List",
"text": "You may find it easier to write your translations in a separate text editor, where you may use spelling and grammar-checking software. Once you've double-checked your translation, you may come back to Superalgos to replace each paragraph with the translated version.",
"updated": 1613825640442
},
{
"style": "List",
"text": "Remember that translations exist at the level of each paragraph. Always make sure that the translation you input matches the correct paragraph. This is important because if a paragraph is updated in the English version, all translations will get a notice that the particular paragraph may be outdated.",
"updated": 1613824142107
},
{
"style": "Success",
"text": "You may start with the translation of the Docs in [Language] page that you land on after you switch the language.",
"updated": 1613823805871
},
{
"style": "Title",
"text": "Translating Tutorials",
"updated": 1613823828960
},
{
"style": "Text",
"text": "Tutorial pages present certain challenges that we must take into account while translating: the first and foremost is that the space available in the tutorial window is limited. This means that you have to be mindful of the length of the translated text and that you must test each of the tutorial steps to make sure the translation fits the available space.",
"updated": 1613825681579
},
{
"style": "Text",
"text": "You will notice that if you open the Docs when a tutorial is running, the Docs automatically load the page of the corresponding tutorial step, so that you may edit it. This is quite helpful, as you may translate the page and see how it looks on the tutorial window in real-time.",
"updated": 1613825697215
},
{
"style": "Important",
"text": "However, this is not always the case. Some tutorial steps are configured to close the Docs or the editor, and when you open the Docs manually, the tutorial step page is not loaded automatically. In such cases, you must search for the name of the page — which should match the title of the tutorial step — so that you may access the page manually.",
"updated": 1613825460620
}
]
}
@@ -3,25 +3,31 @@
"pageNumber": "1",
"type": "Docs In English",
"definition": {
"text": "The Docs articles are fully written in English. The system allow users to search / browse articles in other languages as well, as long as other users contribute translations."
"text": "The Docs pages of Superalgos and other projects integrated are originally written in English. The system allows users to search and browse pages in other languages as well, as long as users have previously contributed the corresponding translations.",
"updated": 1613820592771
},
"paragraphs": [
{
"style": "Text",
"text": "Superalgos and any other integrated project are written in English, since English is considered the default language. Node types, variable names, etc., all is originally in English language. "
"text": "English is considered the default language. When you switch to a different language, the system attempts to show the content in the new language. However, if the translation is not yet available, it shows the English version instead.",
"updated": 1613820612132
},
{
"style": "Text",
"text": "The Docs content can be translated by anyone willing to contribute some time doing so. That helps users to read the contents of the Docs in their native language. "
"text": "Node types, variable names, the title of pages in the Docs, and a few more elements of Superalgos may not be translated, as they are unique identifiers of the said elements. You will always get those in English."
},
{
"style": "Success",
"text": " Users can switch between languages using the links provided at the footer of every page at the Docs. ",
"updated": 1609085068937
"text": "If you wish to contribute translations, read the How to Contribute Translations page."
},
{
"style": "Success",
"text": "To switch languages, click on the flags on the footer of the Docs."
},
{
"style": "Note",
"text": "You can only add or delete pages to the Docs if you are navigating it in English, because English is the default language, and from there pages are later translated. "
"text": "You may only add or delete pages to the Docs when the language is set to English.",
"updated": 1613820648230
}
]
}
@@ -3,8 +3,8 @@
"pageNumber": "2",
"type": "Docs In Spanish",
"definition": {
"text": "The Docs articles are fully written in English. The system allow users to search / browse articles in other languages as well, as long as other users contribute translations.",
"updated": 1609831763845,
"text": "The Docs pages of Superalgos and other projects integrated are originally written in English. The system allows users to search and browse pages in other languages as well, as long as users have previously contributed the corresponding translations.",
"updated": 1613820592771,
"translations": [
{
"language": "ES",
@@ -17,8 +17,8 @@
"paragraphs": [
{
"style": "Text",
"text": "Superalgos and any other integrated project are written in English, since English is considered the default language. Node types, variable names, etc., all is originally in English language.",
"updated": 1609831777974,
"text": "English is considered the default language. When you switch to a different language, the system attempts to show the content in the new language. However, if the translation is not yet available, it shows the English version instead.",
"updated": 1613820612132,
"translations": [
{
"language": "ES",
@@ -28,6 +28,14 @@
}
]
},
{
"style": "Text",
"text": "Node types, variable names, the title of pages in the Docs, and a few more elements of Superalgos may not be translated, as they are unique identifiers of the said elements. You will always get those in English."
},
{
"style": "Success",
"text": "If you wish to contribute translations, read the How to Contribute Translations page."
},
{
"style": "Success",
"text": "Users can switch between languages using the links provided at the footer of every page at the Docs.",
@@ -40,6 +48,11 @@
"style": "Success"
}
]
},
{
"style": "Note",
"text": "You may only add or delete pages to the Docs when the language is set to English.",
"updated": 1613820648230
}
]
}
@@ -3,28 +3,31 @@
"pageNumber": "3",
"type": "Docs In Russian",
"definition": {
"text": "The Docs articles are fully written in English. The system allow users to search / browse articles in other languages as well, as long as other users contribute translations.",
"updated": 1609832026056
"text": "The Docs pages of Superalgos and other projects integrated are originally written in English. The system allows users to search and browse pages in other languages as well, as long as users have previously contributed the corresponding translations.",
"updated": 1613820592771
},
"paragraphs": [
{
"style": "Text",
"text": "Superalgos and any other integrated project are written in English, since English is considered the default language. Node types, variable names, etc., all is originally in English language.",
"updated": 1609832046885
"text": "English is considered the default language. When you switch to a different language, the system attempts to show the content in the new language. However, if the translation is not yet available, it shows the English version instead.",
"updated": 1613820612132
},
{
"style": "Text",
"text": "The Docs content can be translated by anyone willing to contribute some time doing so. That helps users to read the contents of the Docs in their native language."
"text": "Node types, variable names, the title of pages in the Docs, and a few more elements of Superalgos may not be translated, as they are unique identifiers of the said elements. You will always get those in English."
},
{
"style": "Success",
"text": "Users can switch between languages using the links provided at the footer of every page at the Docs.",
"updated": 1609832065974
"text": "If you wish to contribute translations, read the How to Contribute Translations page."
},
{
"style": "Success",
"text": "To switch languages, click on the flags on the footer of the Docs."
},
{
"style": "Note",
"text": "You can only add or delete pages to the Docs if you are navigating it in English, because English is the default language, and from there pages are later translated.",
"updated": 1609832076465
"text": "You may only add or delete pages to the Docs when the language is set to English.",
"updated": 1613820648230
}
]
}
@@ -3,7 +3,8 @@
"pageNumber": "4",
"type": "Docs In Italian",
"definition": {
"text": "The Docs articles are fully written in English. The system allow users to search / browse articles in other languages as well, as long as other users contribute translations.",
"text": "The Docs pages of Superalgos and other projects integrated are originally written in English. The system allows users to search and browse pages in other languages as well, as long as users have previously contributed the corresponding translations.",
"updated": 1613820592771,
"translations": [
{
"language": "IT",
@@ -15,7 +16,8 @@
"paragraphs": [
{
"style": "Text",
"text": "Superalgos and any other integrated project are written in English, since English is considered the default language. Node types, variable names, etc., all is originally in English language. ",
"text": "English is considered the default language. When you switch to a different language, the system attempts to show the content in the new language. However, if the translation is not yet available, it shows the English version instead.",
"updated": 1613820612132,
"translations": [
{
"language": "IT",
@@ -24,9 +26,18 @@
}
]
},
{
"style": "Text",
"text": "Node types, variable names, the title of pages in the Docs, and a few more elements of Superalgos may not be translated, as they are unique identifiers of the said elements. You will always get those in English."
},
{
"style": "Success",
"text": "If you wish to contribute translations, read the How to Contribute Translations page."
},
{
"style": "Text",
"text": "The Docs content can be translated by anyone willing to contribute some time doing so. That helps users to read the contents of the Docs in their native language. ",
"updated": 1613820592771,
"translations": [
{
"language": "IT",
@@ -37,8 +48,8 @@
},
{
"style": "Success",
"text": " Users can switch between languages using the links provided at the footer of every page at the Docs. ",
"updated": 1609085068937,
"text": "To switch languages, click on the flags on the footer of the Docs.",
"updated": 1613820592771,
"translations": [
{
"language": "IT",
@@ -49,7 +60,8 @@
},
{
"style": "Note",
"text": "You can only add or delete pages to the Docs if you are navigating it in English, because English is the default language, and from there pages are later translated. ",
"text": "You may only add or delete pages to the Docs when the language is set to English.",
"updated": 1613820648230,
"translations": [
{
"language": "IT",
@@ -3,25 +3,31 @@
"pageNumber": "5",
"type": "Docs In Simplified Chinese-Mandarin",
"definition": {
"text": "The Docs articles are fully written in English. The system allow users to search / browse articles in other languages as well, as long as other users contribute translations."
"text": "The Docs pages of Superalgos and other projects integrated are originally written in English. The system allows users to search and browse pages in other languages as well, as long as users have previously contributed the corresponding translations.",
"updated": 1613820592771
},
"paragraphs": [
{
"style": "Text",
"text": "Superalgos and any other integrated project are written in English, since English is considered the default language. Node types, variable names, etc., all is originally in English language. "
"text": "English is considered the default language. When you switch to a different language, the system attempts to show the content in the new language. However, if the translation is not yet available, it shows the English version instead.",
"updated": 1613820612132
},
{
"style": "Text",
"text": "The Docs content can be translated by anyone willing to contribute some time doing so. That helps users to read the contents of the Docs in their native language. "
"text": "Node types, variable names, the title of pages in the Docs, and a few more elements of Superalgos may not be translated, as they are unique identifiers of the said elements. You will always get those in English."
},
{
"style": "Success",
"text": " Users can switch between languages using the links provided at the footer of every page at the Docs. ",
"updated": 1609085068937
"text": "If you wish to contribute translations, read the How to Contribute Translations page."
},
{
"style": "Success",
"text": "To switch languages, click on the flags on the footer of the Docs."
},
{
"style": "Note",
"text": "You can only add or delete pages to the Docs if you are navigating it in English, because English is the default language, and from there pages are later translated. "
"text": "You may only add or delete pages to the Docs when the language is set to English.",
"updated": 1613820648230
}
]
}
@@ -3,25 +3,31 @@
"pageNumber": "6",
"type": "Docs In Bahasa",
"definition": {
"text": "The Docs articles are fully written in English. The system allow users to search / browse articles in other languages as well, as long as other users contribute translations."
"text": "The Docs pages of Superalgos and other projects integrated are originally written in English. The system allows users to search and browse pages in other languages as well, as long as users have previously contributed the corresponding translations.",
"updated": 1613820592771
},
"paragraphs": [
{
"style": "Text",
"text": "Superalgos and any other integrated project are written in English, since English is considered the default language. Node types, variable names, etc., all is originally in English language. "
"text": "English is considered the default language. When you switch to a different language, the system attempts to show the content in the new language. However, if the translation is not yet available, it shows the English version instead.",
"updated": 1613820612132
},
{
"style": "Text",
"text": "The Docs content can be translated by anyone willing to contribute some time doing so. That helps users to read the contents of the Docs in their native language. "
"text": "Node types, variable names, the title of pages in the Docs, and a few more elements of Superalgos may not be translated, as they are unique identifiers of the said elements. You will always get those in English."
},
{
"style": "Success",
"text": " Users can switch between languages using the links provided at the footer of every page at the Docs. ",
"updated": 1609085068937
"text": "If you wish to contribute translations, read the How to Contribute Translations page."
},
{
"style": "Success",
"text": "To switch languages, click on the flags on the footer of the Docs."
},
{
"style": "Note",
"text": "You can only add or delete pages to the Docs if you are navigating it in English, because English is the default language, and from there pages are later translated. "
"text": "You may only add or delete pages to the Docs when the language is set to English.",
"updated": 1613820648230
}
]
}