Size: a a a

DocOps-сообщество

2020 December 04

ML

Maksim Lapshin in DocOps-сообщество
Коллеги, кто-нибудь внедрял систему комментариев для документации?

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

Кто и как решает такое?

Я сходу вспомнил только hypercomments и то, потому что участвовал в их проектировании на старте
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Maksim Lapshin
> который в разы уступает тому же комментированию в гугле, например.

в видели как в гитлабе комментируются MR?
А вот мы с вами обсуждали комменты на документации, кроме решений из той цепочки сообщений вряд ли что-то новое появится

Мне кажется, нужно собраться и сделать вместе в open-source что-то
источник

ML

Maksim Lapshin in DocOps-сообщество
Vadim Smelyanskiy
А вот мы с вами обсуждали комменты на документации, кроме решений из той цепочки сообщений вряд ли что-то новое появится

Мне кажется, нужно собраться и сделать вместе в open-source что-то
воу-воу, аналог disqus в опенсор?  Какие-то варианты были, но они ой как непросты
источник

ML

Maksim Lapshin in DocOps-сообщество
а вот обсуждение не помню, можете напомнить?
источник

EN

Ekaterina Noskova in DocOps-сообщество
Maksim Lapshin
Коллеги, кто-нибудь внедрял систему комментариев для документации?

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

Кто и как решает такое?

Я сходу вспомнил только hypercomments и то, потому что участвовал в их проектировании на старте
есть такое
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Там реплай на сообщение, где цепочка начинается, можно оттуда читать

Если кратко: что-то, чтобы прилепить комменты на произвольную веб-страничку есть, но потом боль с исходником сличать. Сошлись на мысли, что нужны sourcemap'ы для исходников доки. @Lananovikova скинула интересную либу, которая прямо в отрендеренный HTML пишет, из-за какой строчки MD появился этот блок.
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Альтернатива, которую тогда озвучили, публиковать в docx и делать комменты в Ворде

Ещё я видел такую публикацию в Confluence
источник

PD

Phil Delgyado in DocOps-сообщество
Кстати, коллеги, кто использует Confluence - куда мигрировать собираетесь за эти три года?
источник

ML

Maksim Lapshin in DocOps-сообщество
меня интересуют тут комментарии скорее как простейший механизм постановки задач, т.е. очень временный сторадж.
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Мне кажется, надо препроцессоры к Foliant'у хачить идти и вкручивать соответствие AST маркдауна к результату в конце
источник

ML

Maksim Lapshin in DocOps-сообщество
Phil Delgyado
Кстати, коллеги, кто использует Confluence - куда мигрировать собираетесь за эти три года?
Что за лимит про 3 года?
источник

L

Lana in DocOps-сообщество
Вроде еще в том же треде вот такой вариант обсуждали https://web.hypothes.is/for-publishers/#embedding
источник

L

Lana in DocOps-сообщество
Maksim Lapshin
Что за лимит про 3 года?
атлассиан прекращает поддержку серверных версий всего с 2024, последний месяц они продаются, потом можно остаться на серверное, но без обновлений и поддержки
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Maksim Lapshin
меня интересуют тут комментарии скорее как простейший механизм постановки задач, т.е. очень временный сторадж.
А, тогда любую либу для прикрутки комментов к веб-странице можно в шаблон добавить
источник

ML

Maksim Lapshin in DocOps-сообщество
Vadim Smelyanskiy
Мне кажется, надо препроцессоры к Foliant'у хачить идти и вкручивать соответствие AST маркдауна к результату в конце
да не, вообще не то.

Я зашел на страницу, вижу там багу.

Хочу выделить кусок и написать «тут написана фигня. Эй вы там, разберитесь».

Ответственный техпис видит и правит это
источник

PD

Phil Delgyado in DocOps-сообщество
Maksim Lapshin
Что за лимит про 3 года?
Atlassian все продукты переводит в облако (или покупай datacenter). Поддержка еще три года и все.
источник

ML

Maksim Lapshin in DocOps-сообщество
Phil Delgyado
Atlassian все продукты переводит в облако (или покупай datacenter). Поддержка еще три года и все.
такой смелый поступок.

Помнится, exist.ru так же решил героически переехать на SAP за новогодние каникулы. Помянем героев
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Maksim Lapshin
да не, вообще не то.

Я зашел на страницу, вижу там багу.

Хочу выделить кусок и написать «тут написана фигня. Эй вы там, разберитесь».

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

Мы тут докопс делаем же! 🙂
источник

PD

Phil Delgyado in DocOps-сообщество
Это не про переезд, это про "пошла мелочь нафиг, лень с вами возиться"
Конечно, за это время могут и передумать...
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Хочу плагины к VSCode/IntelliJ IDEA, куда комменты на исходник будут падать
источник