malhuda/AdguardKnowledgeBase
1
0
Fork 0
mirror of https://github.com/AdguardTeam/AdguardKnowledgeBase.git synced 2025-02-20 11:13:10 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #873 from AdguardTeam/agm-931-translation-mentions-other-languages

Browse Source 
[agm-931] Add translation mentions ru+en
This commit is contained in:
alim-shakirov 2021-06-24 15:40:39 +03:00 committed by GitHub
commit 23fb8624c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
12.miscellaneous/02.updating-kb/docs.en.md
View File

@ -35,7 +35,7 @@ So, what is pull request (or PR)? To put it simply, it is kind of a message to t
## Writing new articles
To write a completely new article is a much more laborious task. But if you are determined to go down this path, do the following. First, make sure your article has a place in AdGuard Knowledgebase. It should be either related to one of the AdGuard products in some way, or be "Meta" (examples of such "meta-articles" are any of the [General questions](https://kb.adguard.com/en)) articles, or this one. Now, when you have found an appropriate topic, go to the [repository](https://github.com/AdguardTeam/AdguardKnowledgeBase) and then to the most suitable category (for example, let's say it is [Android — Solving Problems](https://github.com/AdguardTeam/AdguardKnowledgeBase/tree/master/04.android/06.solving-problems)). Press the "Create new file" button in the top-right part of the screen and name your file. Take into account that you need to create a new folder (by analogy with all the other folders in this category). The file itself should always be named `docs.en.md` for articles in English.
To write a completely new article is a much more laborious task. But if you are determined to go down this path, do the following. First, make sure your article has a place in AdGuard Knowledgebase. It should be either related to one of the AdGuard products in some way, or be "Meta" (examples of such "meta-articles" are any of the [General questions](https://kb.adguard.com/en)) articles, or this one. Now, when you have found an appropriate topic, go to the [repository](https://github.com/AdguardTeam/AdguardKnowledgeBase) and then to the most suitable category (for example, let's say it is [Android — Solving Problems](https://github.com/AdguardTeam/AdguardKnowledgeBase/tree/master/04.android/06.solving-problems)). Press the "Create new file" button in the top-right part of the screen and name your file depending on the language of your article: `docs.zh.md` for Chinese, `docs.en.md` for English, `docs.ja.md` for Japanese, `docs.ko.md` for Korean and `docs.ru.md` for Russian (**at the moment, we accept articles only in these languages**). Take into account that you need to create a new folder (by analogy with all the other folders in this category). The new folder's name will be then a part of your article's URL so please choose the name of it carefully.
Notice that at the top of every file there should be a certain header:
@ -54,7 +54,7 @@ Type the rest of the text below (use [Markdown](https://github.com/LewisVo/Markd
## Translating an article
This part is tricky. Currently, our Knowledgebase only supports the English and Russian languages, but we can envision a future where we have many more to choose from. You can help us lay the foundation of this future by suggesting translations to existing articles. Everything that was said about [writing new articles](#new-article) applies here too, the main difference is that you should always create the new file in the same folder as the original one, and name it accordingly (e.g. `docs.es.md` for Spanish). Use the English original's raw text to copy the structure of the article, it will eliminate a lot of possible misunderstandings and inconsistencies.
This part is tricky. Currently, our Knowledgebase supports the Chinese, English, Japanese, Korean and Russian languages. You can help us by suggesting translations to existing articles in these languages. Everything that was said about [writing new articles](#new-article) applies here too, the main difference is that you should always create the new file in the same folder as the original one, and name it accordingly (e.g. `docs.ko.md` for Korean). Use the English original's raw text to copy the structure of the article, it will eliminate a lot of possible misunderstandings and inconsistencies.
<a name="issues"></a>

8
12.miscellaneous/02.updating-kb/docs.ru.md
View File

@ -40,9 +40,7 @@ visible: true
## Создание новой статьи
Написать и предложить совершенно новую статью для Базы знаний — процесс, требующий огромных усилий. Но если вы все-таки решились на это, не забудьте учесть следующие моменты. Прежде всего, вам необходимо убедиться в том, что ваша статья найдет свое место
в нашей Базе знаний. Она должна либо относиться непосредственно к продуктам AdGuard, либо содержать в себе метаинформацию (среди примеров можно отметить некоторые статьи Базы знаний раздела [Общие вопросы](https://kb.adguard.com/ru) или данную статью). Теперь, когда вы определились с тематикой, отправляйтесь в [репозиторий](https://github.com/AdguardTeam/AdguardKnowledgeBase)
и выбирайте наиболее подходящую категорию (например: [Android — Solving Problems](https://github.com/AdguardTeam/AdguardKnowledgeBase/tree/master/05.android/06.solving-problems)). Пожалуйста, помните: для написания статьи вам потребуется создать новую папку (по аналогии с другими папками в этой же категории). Далее нажмите на кнопку "Create new file" в правой верхней части экрана и назовите данный файл `docs.ru.md` (для статей на русском языке).
Написать и предложить совершенно новую статью для Базы знаний — процесс, требующий огромных усилий. Но если вы все-таки решились на это, не забудьте учесть следующие моменты. Прежде всего, вам необходимо убедиться в том, что ваша статья найдет свое место в нашей Базе знаний. Она должна либо относиться непосредственно к продуктам AdGuard, либо содержать в себе метаинформацию (среди примеров можно отметить некоторые статьи Базы знаний раздела [Общие вопросы](https://kb.adguard.com/ru) или данную статью). Теперь, когда вы определились с тематикой, отправляйтесь в [репозиторий](https://github.com/AdguardTeam/AdguardKnowledgeBase) и выбирайте наиболее подходящую категорию (например: [Android — Solving Problems](https://github.com/AdguardTeam/AdguardKnowledgeBase/tree/master/05.android/06.solving-problems)). Пожалуйста, помните: для написания статьи вам потребуется создать новую папку (по аналогии с другими папками в этой же категории). Имя новой папки станет частью URL-адреса вашей статьи, поэтому, пожалуйста, тщательно выбирайте ее название. Далее нажмите на кнопку "Create new file" в правой верхней части экрана и назовите данный файл в зависимости от выбранного языка: `docs.zh.md` для статьи на китайском, `docs.en.md` - на английском, `docs.ja.md` - на японском, `docs.ko.md` - на корейском и `docs.ru.md` - на русском (**в данный момент, мы принимаем статьи только на этих языках**).
Обратите внимание на заголовок, который должен присутствовать в верхней части каждой статьи:
@ -63,9 +61,7 @@ visible: true
## Перевод статьи
Перевод статьи — задача не из простых. В настоящее время наша База знаний содержит информацию только на английском и русском языках.
Вы можете заложить фундамент для будущего, в котором появится возможность выбирать переводы статей Базы знаний AdGuard и на другие
языки. Для того, чтобы предложить свой перевод, вам необходимо действовать по тому же принципу, который описан в разделе [Создание новой статьи](#new-article). Главное различие заключается лишь в том, что вам потребуется создать новый файл в той же самой папке, где располагается оригинальный текст, и назвать его соответствующим образом (например, `docs.es.md` для испанского языка). При переводе мы советуем вам использовать структуру оригинальной версии статьи как образец во избежание возможных недоразумений и несоответствий.
Перевод статьи — задача не из простых. В настоящее время наша База знаний содержит информацию на английском, китайском, корейском, русском и японском языках. Вы можете помочь нам с переводом статей на эти языки. Для того, чтобы предложить свой перевод, вам необходимо действовать по тому же принципу, который описан в разделе [Создание новой статьи](#new-article). Главное различие заключается лишь в том, что вам потребуется создать новый файл в той же самой папке, где располагается оригинальный текст, и назвать его соответствующим образом (например, `docs.ko.md` для корейского языка). При переводе мы советуем вам использовать структуру оригинальной версии статьи как образец во избежание возможных недоразумений и несоответствий.
<a name="issues"></a>