Size: a a a

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

2020 November 12

IC

Ivan Cheban in DocOps-сообщество
источник

IC

Ivan Cheban in DocOps-сообщество
Коллеги, недавно здесь обсуждали возможность ревьювить документацию, собранную генератором статических сайтов. Там, конечно, были пожелания, чтобы все это было подвязано к гиту. Но вот решение, которое позволяет вашим не очень продвинутым коллегам из продуктовой части почитать документацию, собранную, скажем на стейдже в таком виде, как она будет на продакшене, и оставить комментарии, как в конфлюэнсе, пдф или ворде прямо по тексту доки.
Вот здесь написано, как это вставить в код сайта. Там всего одна строчка кода:
https://web.hypothes.is/for-publishers/#embedding
источник

IC

Ivan Cheban in DocOps-сообщество
Выше я записал видео со своего личного сайта с документацией, собранного на Хьюго
источник

FM

Fox Mulder in DocOps-сообщество
Ivan Cheban
Выше я записал видео со своего личного сайта с документацией, собранного на Хьюго
ничего там не видно ,увы
источник

FM

Fox Mulder in DocOps-сообщество
Но если это то, что я думаю - это просто шедевр
источник

IC

Ivan Cheban in DocOps-сообщество
У меня в Хроме запускается. Просто там 112 МБ, долго грузится. Хотел, чтобы было видно детали
источник

FM

Fox Mulder in DocOps-сообщество
Ivan Cheban
У меня в Хроме запускается. Просто там 112 МБ, долго грузится. Хотел, чтобы было видно детали
Иван, а этот скрипт получается не будет работать в изолированной среде?
источник

IC

Ivan Cheban in DocOps-сообщество
Не знаю, что ты имеешь в виду. Я просто вставил <script src="https://hypothes.is/embed.js" async></script> в свой файл head.html
источник

IC

Ivan Cheban in DocOps-сообщество
Ну и нужно было зарегистрироваться на их сайте, чтобы можно было оставлять аннотации
источник

FM

Fox Mulder in DocOps-сообщество
Ivan Cheban
Ну и нужно было зарегистрироваться на их сайте, чтобы можно было оставлять аннотации
Всё понял тогда. Это был следующий вопрос, который я хотел спросить ))
Не, тогда не пойдёт эта тулза, так как комменты хранятся в базе на стороннем ресурсе, а это небезопасно.
источник

IC

Ivan Cheban in DocOps-сообщество
Да. Можно даже зайти на их сайт в свою учетку и посмотреть комменты
источник

IC

Ivan Cheban in DocOps-сообщество
источник

IC

Ivan Cheban in DocOps-сообщество
Вот здесь я оставлял этот коммент:
https://docsy-site.netlify.app/docs/static-site-generators/hugo-install/
источник
2020 November 13

FM

Fox Mulder in DocOps-сообщество
источник
2020 November 14

BF

Bobba Fett in DocOps-сообщество
Ivan Cheban
Коллеги, недавно здесь обсуждали возможность ревьювить документацию, собранную генератором статических сайтов. Там, конечно, были пожелания, чтобы все это было подвязано к гиту. Но вот решение, которое позволяет вашим не очень продвинутым коллегам из продуктовой части почитать документацию, собранную, скажем на стейдже в таком виде, как она будет на продакшене, и оставить комментарии, как в конфлюэнсе, пдф или ворде прямо по тексту доки.
Вот здесь написано, как это вставить в код сайта. Там всего одна строчка кода:
https://web.hypothes.is/for-publishers/#embedding
Спасибо! Из сервисов, которые позволяют что-то похожее делать, есть ещё:
https://usepastel.com/ 
https://www.markup.io/
источник
2020 November 15

IC

Ivan Cheban in DocOps-сообщество
Спасибо! Пробовал эти два сервиса. Они дублируют свои функции. Принципиальная разница з hypothes.is — нужно заходить на страницу сервиса и там работать с комментами. У гипотезы JS код встраивается в код страницы, поэтому можно открыть сайт и работать с комментами прямо на сайте без перехода на сторонний сервис. Плюс там всякие мелочи типа выделенного желтым куска текста, который комментируется.
источник
2020 November 17

NK

ID:0 in DocOps-сообщество
У меня тут заканчивается второй день отпуска, и я постепенно начинаю понимать, что отпуск стоило взять 1) гораздо раньше и 2) на гораздо больший срок, может быть, на месяц.

Берегите себя, друзья. :)
источник

AR

Anna Ryutina in DocOps-сообщество
месяц много, два дня мало конечно) две недели самое то
источник

OI

Olga Ilchukova in DocOps-сообщество
Отдыхать никогда не мало, особенно после тяжелого рабочего периода без нормального восстановления. Иначе до выгорания рукой подать.

Коля, отличного тебе отпуска, оторвись, как следует :)
источник

H

Hartmann in DocOps-сообщество
ID:0
У меня тут заканчивается второй день отпуска, и я постепенно начинаю понимать, что отпуск стоило взять 1) гораздо раньше и 2) на гораздо больший срок, может быть, на месяц.

Берегите себя, друзья. :)
Мой друг некогда сказал, что в отпуск нужно ходить каждые 2-3 месяца, минимум, на неделю. :) Чем дольше работаю, тем больше склоняюсь к этому утверждению.
И при этом, в большинстве случаев, отпуск «расчленять» так позволит лишь ограниченное количество работодателей. Ко всему прочему, не всегда можно «съехать» в силу «через неделю релиз», «коллега заболел» и тд.
Суровая реальность, она другая.
источник