Readthedocs.org: Пользователь флага функции документа может запросить нас

Созданный на 27 дек. 2018  ·  4Комментарии  ·  Источник: readthedocs/readthedocs.org

У нас есть несколько флагов функций, которые можно применять к проектам. Хотя у нас нет документа, который объяснял бы, что они есть и как запросить их включение.

Список доступных флагов функций,

https://github.com/rtfd/readthedocs.org/blob/dec39ba70315eca338359f8381af4610a3e56274/readthedocs/projects/models.py#L1018 -L1029

Мы должны написать несколько документов об этом, упоминая их и объясняя, как они используются и как их запрашивать.

Источник: https://github.com/rtfd/readthedocs.org/pull/5036#issuecomment -450011872

Accepted documentation

Самый полезный комментарий

Я не думаю, что смысл флагов функций заключается в том, чтобы рекламировать пользователям, чтобы они добавили функцию, это наша задача - управлять флагами внутренне или автоматически. Когда функция готова к производству, пользователь может управлять ею самостоятельно, но для этого не требуются флажки функций.

Наши варианты использования флагов функций:

  • Быстрая итерация, чтобы получить частичную / наполовину запеченную функцию
  • Выборочные сборки для тестирования больших изменений

Мы не должны ожидать, что пользователи попросят нас о функции - функции готовы, когда они будут готовы.

Все 4 Комментарий

@humitos
Если я не ошибаюсь, пользователь должен запросить у администратора включение любого из флагов Feature.
Итак, вот кое-что, о чем я подумал.
В документации мы можем сгруппировать их в отдельный заголовок.
А в администраторе проекта в readthedocs.org мы можем добавить ссылки на них, которые будут перенаправлять на новую проблему в RTD с предварительно заполненными деталями (с именем проекта / slug).
И в документации мы можем сделать то же самое, только необходимые детали проекта должны быть вручную заполнены пользователем.

Изменить: Или мы можем просто добавить в документы.

Я думаю, что достаточно конкретной страницы под нашей документацией. Может быть, еще одна запись в FAQ с общим вопросом вроде: «Я хочу другую конфигурацию, недоступную в Admin» или что-то получше;)

Хорошо.
Работаю над этим.

Я не думаю, что смысл флагов функций заключается в том, чтобы рекламировать пользователям, чтобы они добавили функцию, это наша задача - управлять флагами внутренне или автоматически. Когда функция готова к производству, пользователь может управлять ею самостоятельно, но для этого не требуются флажки функций.

Наши варианты использования флагов функций:

  • Быстрая итерация, чтобы получить частичную / наполовину запеченную функцию
  • Выборочные сборки для тестирования больших изменений

Мы не должны ожидать, что пользователи попросят нас о функции - функции готовы, когда они будут готовы.

Была ли эта страница полезной?
0 / 5 - 0 рейтинги

Смежные вопросы

PowerKiKi picture PowerKiKi  ·  4Комментарии

krzychb picture krzychb  ·  4Комментарии

goerz picture goerz  ·  4Комментарии

cagataycali picture cagataycali  ·  4Комментарии

davidfischer picture davidfischer  ·  4Комментарии