Simplify contribution

[vasiliy-t]

Увидел проблему в доке, могу поправить и сделать PR, но исходник страницы найти сложно, особенно для enterprise доки. Предлагаю добавить типа такого на каждую страницу:

чтобы с любой страницы можно было быстро перейти к исходнику и правки сразу делать

Что нужно сделать

• Попросить у Кати сделать макет  (@artur-barsegyan)
  • Определиться с позицией виджета: под текстом статьи или справа от текста статьи
• Определиться с CTA: направлять на создание issue или в окно Github с редактированием конкретной страницы (@artur-barsegyan / @NickVolynkin )
• Определиться с тем как детектить страницы из Enterprise и модулей
• Определиться с созданием тикетов для Enterprise страниц и давать доступ только залогиненным в группе "Enterprise"

[veod32]

чтобы с любой страницы можно было быстро перейти к исходнику и правки сразу делать

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

1. трекинга истории изменения документации
2. в рамках такой правки может нужны будут еще какие-то действия, про которые не знает контрибьютер-разработчк, но знает команда документации. Например, само изменение может быть одна строчка, но вот в документации по Тарантулу нужно делать еще cherry-pick в другие версии документации, если это изменение относится к другим версиям.

[Totktonada]

Результатом в любом случае будет PR, который команда документации может редактировать / дополнять (возможно, что-то можно и автоматизировать) и после мерджа которого можно будет руками сделать черри-пики.

[NickVolynkin]

@veod32

в документации по Тарантулу нужно делать еще cherry-pick в другие версии документации

это требование с нами ещё недолго пробудет :)

трекинга истории изменения документации

Если мержить с честным мерж-коммитом, в котором есть ссылка на ПР, то можно и без задачи обойтись. Особенно если исправляешь опечатку, не заводить же ради неё ещё и задачу, это удваивает работу.

[NickVolynkin]

@vasiliy-t это отличная идея, спасибо! У нас есть закрытые репозитории, но есть и логин на сайте документации, так что мы сможем сделать и в них такой виджет.

[NickVolynkin]

Думаю, что кнопки должны быть такими:

• Feedback → завести issue в нужном репозитории, по шаблону задачи, сразу заполнить ссылку и заголовок исходного документа.
• Edit → редактировать файл в интерфейсе гитхаба.

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

Кнопки должны быть в сайдбаре справа, всегда на виду, как и кнопки оценки.