Обновление Базы знаний

Цель Базы знаний — предоставить пользователям актуальную информацию по всем вопросам, касающимся AdGuard VPN. Всё в мире постоянно меняется, и наш продукт не исключение, поэтому время от времени статьи перестают отражать реальное положение вещей. Нас не так много, чтобы уследить за каждой крупицей информации и обновлять статьи с выходом последних версий продукта.

По этой причине мы переместили всё содержимое нашей Базы знаний на GitHub, и теперь буквально каждый человек может принять участие в её обновлении — редактировать и переводить существующие статьи или создавать новые.

Как предложить изменения в существующую статью или написать новую

Вы можете предлагать изменения в текущие статьи и добавлять новые в Базу знаний, используя функциональность упомянутого выше GitHub. Если вы не знакомы с принципами работы платформы, начните с прочтения этой документации.

Как только вы будете готовы, начните работу в репозитории KnowledgeBaseVPN. Все тексты в нашей Базе знаний написаны на языке разметки Markdown. Помните об этом при редактировании или написании статей. Перейдите по этой ссылке, чтобы узнать больше о синтаксисе Markdown.

Сайт Базы знаний создан с помощью Docusaurus 2 — современного генератора статических сайтов. Предлагая изменения или дополнения, учитывайте, что все документы должны соответствовать принципам работы платформы. Вы можете прочитать о них в этом руководстве.

Вы можете развернуть эту базу знаний локально на своём компьютере для предварительного просмотра предложенных изменений. Подробные инструкции о том, как это сделать, можно найти в файле README.md на странице GitHub этой Базы знаний.

Переводы статей

Cуществующие статьи Базы знаний можно перевести на платформе Crowdin. Все подробности о переводах статей и работе с Crowdin можно найти в соответствующей статье Базы знаний блокировщика рекламы AdGuard.

Работая над статьями Базы знаний AdGuard VPN, вы наверняка встретите строки, содержащие формы множественного числа, которые следует переводить с особой аккуратностью. В отдельной статье мы подробно описали трудности, которые могут возникнуть при переводе таких строк, и дали исчерпывающие инструкции по работе с ними на платформе Crowdin.

Работа над существующими задачами

Иногда появляются открытые задачи, связанные с обновлением Базы знаний. Вы можете помочь нам завершить их так же, как вы предлагаете любые другие изменения в эту Базу знаний. Выберите любую задачу, которая кажется вам привлекательной, и начните работать над ней. Все возникающие вопросы вы можете задавать прямо в комментариях к задаче.