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

Введение

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

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

Как предложить изменения?

Прежде всего вам понадобится аккаунт на GitHub. Его можно создать, перейдя по ссылке: https://github.com/join. Теперь, когда с этим разобрались, вы можете сразу погрузиться в работу над статьями, список которых вы найдете здесь. Выберите любую статью, в которую вы хотели бы внести свои изменения, и нажмите docs.ru.md файл (при условии, что вы пишете на русском языке). Затем “кликните” на значок карандаша в правом верхнем углу рамки для того, чтобы начать редактирование.

Итак, настало время проявить себя! Измените статью так, как вы считаете нужным (используйте Markdown!),
придумайте краткое описание и название для вашего пулл реквеста (ориг. — pull request, далее — ПР) и нажмите на "Propose file change".
После этого вы перейдете на другую страницу, где все, что вам будет нужно — это нажать на зеленую кнопку "Create pull request".
Если вы желаете получить более подробную информацию о том, как это работает, читайте руководство по использованию GitHub онлайн.

Что же такое пулл реквест? Это своего рода сообщение, отправленное авторам или администраторам репозитория. Оно говорит о том, что
вы сделали что-то особенное, заслуживающее внимания и добавления в репозиторий. В нашем случае это “что-то” — есть обновление содержания статьи Базы знаний. Администраторы рассмотрят запрос, и, если они сочтут ваши предложения полезными и вместе с тем легитимными, они одобрят его. В противном же случае они могут отклонить ПР и попросить внести некоторые исправления. Просто попробуйте сделать ПР сами, и вы сразу же поймете, как это работает.

Создание новой статьи

Написать и предложить совершенно новую статью для Базы знаний — процесс, требующий огромных усилий. Но если вы все-таки решились на это, не забудьте учесть следующие моменты. Прежде всего, вам необходимо убедиться в том, что ваша статья найдет свое место
в нашей Базе знаний. Она должна либо относиться непосредственно к продуктам AdGuard, либо содержать в себе метаинформацию (среди примеров можно отметить некоторые статьи Базы знаний раздела Общие вопросы или данную статью). Теперь, когда вы определились с тематикой, отправляйтесь в репозиторий
и выбирайте наиболее подходящую категорию (например: Android — Solving Problems). Пожалуйста, помните: для написания статьи вам потребуется создать новую папку (по аналогии с другими папками в этой же категории). Далее нажмите на кнопку "Create new file" в правой верхней части экрана и назовите данный файл docs.ru.md (для статей на русском языке).

Обратите внимание на заголовок, который должен присутствовать в верхней части каждой статьи:

---
title: 'Ваш заголовок'
taxonomy:
    category:
        - docs
visible: true
---

После данного заголовка вы можете вводить основной текст (используйте Markdown!).
Как только ваша статья будет готова, нажмите на "Propose file change", чтобы создать ПР. Затем действуйте по принципу, описанному
выше.

Перевод статьи

Перевод статьи — задача не из простых. В настоящее время наша База знаний содержит информацию только на английском и русском языках.
Вы можете заложить фундамент для будущего, в котором появится возможность выбирать переводы статей Базы знаний AdGuard и на другие
языки. Для того, чтобы предложить свой перевод, вам необходимо действовать по тому же принципу, который описан в разделе Создание новой статьи. Главное различие заключается лишь в том, что вам потребуется создать новый файл в той же самой папке, где располагается оригинальный текст, и назвать его соответствующим образом (например, docs.es.md для испанского языка). При переводе мы советуем вам использовать структуру оригинальной версии статьи как образец во избежание возможных недоразумений и несоответствий.

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

Время от времени появляется потребность в дополнении или обновлении Базы знаний, или какая-либо другая задача, за которую мы по той или иной причине не можем взяться сразу. В таком случае обычно создаётся новая issue (т.е. задача) в специальном репозитории на GitHub. Если вы не знаете, с чего начать, просто идите по этой ссылке, выбирайте любую задачу по силам (и по душе), и принимайтесь за неё. Если есть вопросы — не стесняйтесь спрашивать прямо в комментариях к задаче.

Бесплатная лицензия от AdGuard

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

У нас нет строгих критериев, определяющих, как много нужно сделать для получения бесплатной лицензии от AdGuard. А значит, если вы считаете, что внесли достаточный вклад в обновление Базы знаний, просто отправьте нам сообщение на указанный электронный адрес: st@adguard.com.