Возможности для вклада в документацию

[hugh (Hugh Lashbrooke)]

Документация Discourse — это основное место, где администраторы, модераторы, пользователи и системные администраторы могут найти помощь в использовании Discourse и управлении своими сайтами.

Хотя эта документация обширна и охватывает множество тем, есть некоторые области, которые ещё не описаны. Это отличная возможность для сообщества принять участие в улучшении этой важной части проекта Discourse.

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

Разделы документации

Любой пользователь с уровнем доверия 2 и выше может создавать новые темы с документацией в категории #community-wiki — это место для всего контента документации, созданного сообществом. Если тема в community wiki считается релевантной или важной, она может быть перенесена в категорию Documentation — место для всей официальной документации Discourse. Подробнее об этом можно прочитать в политике документации.

Значки для участников документации

Любой, кто создаст новую тему в категории #community-wiki, автоматически получит бронзовый значок Scribe:

Если тема считается достаточно ценной для переноса в официальную категорию Documentation, член команды Discourse сделает это вручную, укажет оригинального автора в содержании темы и наградит его серебряным значком Ghostwriter:

Документация, которую нужно написать

Хотя в конечном итоге мы хотим, чтобы каждая часть Discourse была подробно описана, ниже перечислены области, которые, по нашему мнению, наиболее остро нуждаются в документации (зачёркнутые пункты обозначают темы, которые уже были написаны с момента публикации этого сообщения):

• Общее руководство по началу работы для администраторов
• Настройка перенаправлений тем
• Объяснение возможностей различных уровней пользователей
• Варианты входа через социальные сети
• Уведомления о сообщениях (официальная документация)
• Дополнительная документация о том, как работают уровни доверия
• Как написать хороший запрос на новую функцию для Discourse (тема в вики)
• Справочник по тому, как выглядит разметка Markdown и функции форматирования Discourse в письмах
• Статусы пользователей (тема в вики)
• Объяснение тёмной темы, как её выбрать и как включить переключение (тема в вики)
• Общая документация по управлению настройками пользователя (тема в вики)
• Документация, объясняющая, как работают категории и иерархия в Discourse
• Общее руководство по настройкам тем
• Общее руководство по плагинам: что это, как они работают и как их использовать
• Пользовательские домашние страницы
• Изменение категорий и тем по умолчанию
• Использование сеток изображений в сообщениях (тема в вики)
• Настройки одобрения сообщений (тема в вики)

Некоторые из этих тем могут потребовать создания нескольких сообщений для эффективного описания.

Как писать документацию

Чтобы документация Discourse была максимально эффективной, у нас есть руководство по стилю для написания такого контента. Хотя всем было бы полезно следовать этому руководству, если вы вносите вклад в #community-wiki, это не проблема, если вы не будете строго ему следовать. Любые темы, перенесённые в Documentation, будут обновлены сотрудниками Discourse в соответствии с руководством по стилю по мере необходимости.

Заинтересованы?

Присоединяйтесь к категории #community-wiki и начните создавать документацию уже сегодня. Если вы хотите обсудить что-либо, не стесняйтесь ответить на эту тему и поговорить об этом.

[Moin]

А что насчет существующих тем? Например,

@Hugh Lashbrooke

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

Promoting a User to Admin or Moderator Status

@Hugh Lashbrooke

Как написать хороший запрос на новую функцию для Discourse

Requesting new features for Discourse

[hugh (Hugh Lashbrooke)]

По поводу этого:

@Moin

@hugh

Как написать хороший запрос на новую функцию для Discourse

Запрос новых функций для Discourse

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

А по поводу этого:

@Moin

@hugh

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

Предоставление прав администратора или модератора пользователю

Отличное замечание! Я уберу это из списка в этой теме

[ondrej]

@Hugh Lashbrooke

Как написать хороший запрос на новую функцию для Discourse

Уже есть тема, посвящённая запросам на новые функции:

Requesting new features for Discourse

This guide explains how to request new features for Discourse, check existing plans, and increase the chances of your feature request being prioritized. Required user level: Anyone can submit a feature request Got a great idea for a Discourse feature? That’s fantastic! Here’s how you can share it with the team effectively. Make sure your feature isn’t already made or planned Before submitting a new feature request, ensure it’s not already available or plann…

Разве это не должно выглядеть так же, но для запроса на новую функцию?

Writing an effective bug report

This is a guide for writing effective bug reports in Discourse to maximize the chances of getting bugs fixed. Required user level: Any can report a bug Writing a good bug report is essential to help the Discourse team fix issues efficiently. This guide will walk you through the steps and best practices to ensure your bug report is clear, concise, and actionable. Summary In this documentation, we’ll cover: The importance of providing reproducible steps and…

[HamMan2118]

@Хью Лашбрук

Опубликовать уведомления

Означает ли это «Уведомление для персонала» или что-то другое?

[ondrej]

Полагаю, это уведомление о публикации, раз оно указано в заголовке.

Post notices for first-time and returning users

To encourage kindness towards users who are posting for the first time or may not have posted in a while we’ve created a new feature that calls special attention to these new/returning users. These banners are visible to other users, but not the poster they apply to… and by default are only visible to community members who have been active enough to achieve Trust Level 2. Here’s what they look like: [image] [image] How can I configure this feature? Admins can adjust these options in their…

Уведомления от сотрудников, наверное, в целом такие же?

[hugh (Hugh Lashbrooke)]

@ondrej

Разве это не должно выглядеть так, но для запроса функции?

Да, именно это мы и имеем в виду

@HamMan2118

@hugh

Уведомления о публикации

Означает ли это «Уведомление для сотрудников» или что-то другое?

Как указал @ondrej, уведомления о публикации описаны в этом объявлении. У нас есть тема с этим объявлением, но нет самой документации по этой теме.

[Heliosurge (Dan DeMontmorency)]

Привет, Hugh, это отличная идея.

Я давно собирался предложить идею для вики сообщества: добавить какой-то тег, например, для шаблонов форумов.

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

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

• Шаблоны форумов поддержки
• Шаблоны учебных платформ

В этих темах можно размещать решения, размещённые на Discourse, Communique (так?), а также рекомендованные плагины и компоненты тем и т.д. Кроме того, стоит добавить пост для варианта с самостоятельным размещением.

Шаблоны для размещённых решений должны фокусироваться на плагинах и указывать, какие тарифные планы необходимы для использования конкретного плагина.

Также можно добавить советы и рекомендации, а также направлять пользователей в раздел Marketplace, если им нужен индивидуальный макет, плагин и т.д.

[NateDhaliwal]

@Хью Лашбрук

Статусы пользователей

Создано:

Custom User Statuses

Summary This document covers: What a Custom User Status Is How to add, modify, and remove a custom user status. Custom User Status Description A Custom User Status is a feature where users can set a custom status and icon to appear in their profile and next to their avatar at posts. This can be used, as a member, to let the community know if you are unavailable, on vacation, or want to share how you are feeling. A custom user status appears like this in a post: [Username "andrei" with a pa…

[hugh (Hugh Lashbrooke)]

Я увидел это Отлично, что они появляются!

[NateDhaliwal]

Работаю над вариантом для тёмной темы.

[NateDhaliwal]

Эти руководства уже созданы, но ещё не отмечены:

@hugh

Статусы пользователей

Custom User Statuses

Summary This document covers: What a Custom User Status Is How to add, modify, and remove a custom user status. Custom User Status Description A Custom User Status is a feature where users can set a custom status and icon to appear in their profile and next to their avatar at posts. This can be used, as a member, to let the community know if you are unavailable, on vacation, or want to share how you are feeling. A custom user status appears like this in a post: [Username "andrei" with a pa…

@hugh

Использование сеток изображений в сообщениях

Image Grids

This guide explains what Image Grids are and how to apply them in your posts. Required user level: Trust Level 0 Summary This document covers: Description of image grids How they can be applied in posts and how to modify them Basic Layout of image grids Image Grids Description An image grid places all of the images in your post into a neat, organized grid - rather than in a list. Below is an example of an image grid. [Delta A321-200 Landing in Washingt…

@hugh

Пользовательские домашние страницы

Здесь есть некоторая неопределённость. Имеется ли в виду пользовательский контент на главной странице? Если да, то, возможно, это Add custom content that only appears on your homepage. В противном случае… это ещё не написано.

[hugh (Hugh Lashbrooke)]

Спасибо, что вернулись к этому вопросу — я обновил исходный пост, добавив эти ссылки.

@NateDhaliwal

Это немного размыто. Имеется ли в виду пользовательский контент главной страницы?

Это довольно узкоспециализированная функция, связанная с созданием пользовательской главной страницы, поэтому ею будут пользоваться далеко не все администраторы Discourse. Это не основная функция, так как на данном этапе она ещё не полностью отполирована.