Документация Discourse — это основное место, где администраторы, модераторы, пользователи и системные администраторы могут найти помощь по использованию Discourse и управлению своими сайтами.
Хотя эта документация обширна и охватывает множество аспектов, есть некоторые области, которые пока не задокументированы. Это отличная возможность для сообщества принять участие в улучшении важной части проекта Discourse.
Мы хотели бы видеть больше людей, участвующих в создании документации для Discourse, и хотим сделать этот процесс максимально простым для всех. В связи с этим ниже приведен список функций или сценариев использования Discourse, для которых, по нашему мнению, требуется новая или улучшенная документация.
Места размещения документации
Любой пользователь с уровнем доверия 2 или выше может создавать новые темы документации в категории Wiki — это основное место для всего контента документации, созданного сообществом. Если тема в community wiki считается релевантной или важной, она может быть перемещена в категорию Documentation — основное место для всей официальной документации Discourse. Подробнее об этом можно прочитать в политике документации.
Значки для авторов документации
Любой, кто создает новую тему в категории Wiki, автоматически получает бронзовое значение «Писец» (Scribe):
Если тема считается достаточно ценной для перемещения в официальную категорию Documentation, сотрудник команды Discourse сделает это вручную, укажет оригинального автора в содержании темы и присвоит ему серебряное значение «Призрак» (Ghostwriter):
Документация, которую необходимо написать
Хотя в конечном итоге мы хотим, чтобы каждая часть Discourse была тщательно задокументирована, вот области, в которых, по нашему мнению, потребность наиболее острая (зачеркнутые пункты означают, что темы уже написаны с момента первой публикации этого сообщения):
- Общий учебник по началу работы для администраторов
- Пользовательские перенаправления тем
- Объяснение того, что могут делать разные уровни пользователей
- Варианты социальной авторизации
- Уведомления о постах (официальная документация)
- Больше документации о том, как работают уровни доверия
- Как написать хороший запрос на новую функцию для Discourse (тема в wiki)
- Справочник по отображению функций Markdown и форматирования Discourse в письмах
- Статусы пользователей (тема в wiki)
- Объяснение темного режима, как его выбрать и как включить переключение (тема в wiki)
- Общая документация по управлению настройками пользователей (тема в wiki)
- Документы, объясняющие, как работают категории и иерархия в Discourse
- Общий руководство по настройкам тем
- Общий справочник по плагинам — что они собой представляют, как работают и как их использовать
- Пользовательские домашние страницы
- Изменение категорий и тем по умолчанию
- [x ] Использование сеток изображений в постах (тема в wiki)
- Настройки одобрения постов (тема в wiki)
Некоторые из этих пунктов могут потребовать создания нескольких тем для эффективной документации.
Как писать документацию
Чтобы документация Discourse была максимально эффективной, у нас есть руководство по стилю, описывающее, как писать этот контент. Хотя было бы полезно, если бы все следовали этому руководству, если вы вносите вклад в Wiki, не обязательно строго придерживаться его. Любые темы, перемещенные в Documentation, будут обновлены сотрудниками Discourse в соответствии с руководством по стилю по мере необходимости.
Заинтересованы?
Загляните в Wiki и начните документировать уже сегодня. Если вы хотите обсудить что-либо из этого, не стесняйтесь отвечать на эту тему, чтобы поговорить об этом.
Отлично, что они появляются!