Lorawan-stack: Шаблон выпуска для вопросов

таким образом, «действие» будет заключаться в том, что мы обновим документацию напрямую (если это единственное изменение), ссылаясь на эту проблему, и откроем другую, если это приведет к исправлению ошибки / запросу функции?

Точно. Результатом "вопроса" обычно должно быть изменение в нашей документации или дополнение к нашему FAQ.

Я не знаю, имеет ли смысл копировать и вставлять проблему «вопрос» в проблему «отчет об ошибке». Возможно, нам следует просто добавить соответствующие разделы в комментарии (или отредактировать проблему), если мы решим превратить вопрос в отчет об ошибке или функцию.

Согласен, но это также относится к форуму и slack.

По сути, вся информация должна быть в документации репозитория, если какая-то информация является ссылкой на форум, проблемами или слабиной, то нам не удалось сделать документацию.
Вопрос или проблема, поднятые в Slack, форум должен компенсировать изменения в документе, если не было предпринято никаких усилий для поиска информации.

Вместо того, чтобы иметь список «Вы смотрели там», я бы добавил ссылку на запрос на github / doc (после того, как поиск будет выполнен). Поиск информации в проблемах github может быть утомительным, и форум не должен содержать информацию/объяснение, которого нет в документе. Ссылка на уже установленный запрос (типа поиска багов) поможет. Также можно предусмотреть добавление раздела известных ошибок в документы.

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

Я полностью согласен с тем, что нам лучше следить за Форумом и Slack и превращать (хорошие) вопросы в улучшения документации (по крайней мере, для категории v3 и канала lorawan-stack ). @Sypheos, как бы вы увидели, что это работает на практике?

Цель «Вы смотрели здесь» была скорее фильтром для людей, отправляющих вопросы, прежде чем вообще выполнять какой-либо поиск. Следующий раздел более полезен, здесь мы можем попросить отправителя задачи дать ссылку (или процитировать) на соответствующие сообщения форума, сообщения в slack и т. д.

Я думаю, это хорошая идея. Давайте сохраним объем этой проблемы и шаблон проблемы действительно новый вопрос.

Что касается улучшения документации, т.е. неофициальных ответов на форуме и в Slack о том, что нам нужна часть документации, мы можем рассмотреть дополнительный шаблон задачи «запрос документации», который является минимальным; он в основном описывает пробелы в документации и ссылку на то, где сейчас находится информация, если таковая имеется (т. е. ссылку на форум/сообщение в Slack). Но опять же, для меня, вне рамок этого вопроса.

Для шаблона вопроса imo:
Что ищете/делаете?
Где ты смотрел?
_Добавьте любую веб-страницу, проблемы, запросы на github, документы, форум приветствуются_
Почему не удовлетворил?
_404 не найдено — правильный ответ_

Метка: вопрос

если нет ресурсов для ответа на вопрос, откройте вопрос «запрос документации».

Мы действительно должны убедиться, что все ответы попадут в документацию, иначе закрытые вопросы здесь станут базой знаний V3, и мы должны избегать этого. Так что, возможно, нам следует даже пропустить шаблон «вопрос» и сразу перейти к «запросу документации».

Кроме того, когда использование этого репозитория растет, и это становится местом для вопросов, и нам становится трудно модерировать это (т.е. указывать на документы и закрывать проблемы), мы можем пожалеть об этом в будущем. Обратите внимание, что большие репозитории, такие как VS Code, сообщают, что вам не следует задавать вопросы слишком агрессивно:

Короче говоря, давайте рассмотрим;

• Не разрешать вопросы вообще, только вопросы "запроса документации". Вопросы по-прежнему действительны, но только если они действительно не задокументированы, в противном случае это недействительный запрос документации, и мы закрываем его.
• Прямые вопросы к документам (когда они у нас есть) и форумам

Запрос документации на самом деле является «Вопросами», поскольку они что-то искали, но не могли найти. В начале у них есть вопрос, который требует ответа.
Чтобы двигаться в этом направлении, было бы разумнее просто отклонить любой запрос документации и вопросы через тикеты на github.

Если кто-то хочет задать вопрос, он идет в slack или на форум, где кто-то из основной команды или модератора может превратить свой вопрос в документацию PR / проблему с ошибкой / проблему с запросом функции.

Решение: мы выберем https://github.com/TheThingsNetwork/lorawan-stack/issues/890#issuecomment -507324845. Шаблон вопроса, который ведет на форум, и шаблон запроса документации