Size: a a a

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

2019 July 25

K

Konstantin in DocOps-сообщество
Lev Zabudko
Спасибо большое! Будем смотреть! Антора все же не совсем то, так как там аскидок
И приходите завтра на митап Write The Docs, если в Москве, можно будет обсудить лично: https://it.rt.ru/rt_event/docops-meetup/
источник

IA

Ivan Abashkin in DocOps-сообщество
Lev Zabudko
Попросил админов поставить. На днях сравним, может и переедем. Xwiki никому не нравится, но за неимением лучшего - ведем ее
расскажите плизз потом о впечатлениях. интересно как оно в сравнении
источник

LZ

Lev Zabudko in DocOps-сообщество
Хорошо :)
источник
2019 July 26

IA

Ivan Abashkin in DocOps-сообщество
Клёво, оказывается ProGit написан на аскидоке.
https://github.com/progit/progit2

Интересо организован подход к переводам:
https://github.com/progit/progit2-ru

А кто знает, какие ещё есть опен-сорс книжки, работа над которыми ведётся в гите?
источник

НН

Нац Нац in DocOps-сообщество
источник

IA

Ivan Abashkin in DocOps-сообщество
Спасибо!

По ссылке книжка от автора этой статьи. Он её пишет в маркдауне:
https://github.com/bpesquet/thejsway/tree/v1.0

Что-то больше ничего не нашлось.

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

НН

Нац Нац in DocOps-сообщество
Ivan Abashkin
Спасибо!

По ссылке книжка от автора этой статьи. Он её пишет в маркдауне:
https://github.com/bpesquet/thejsway/tree/v1.0

Что-то больше ничего не нашлось.

Хочется на примере уже созданных книг или массивных документов, подсмотреть как народ делает. Приёмы всякие, хаки.
Для книг я бы юзал Scrivener
источник

НН

Нац Нац in DocOps-сообщество
И все там держал бы
источник

NK

ID:0 in DocOps-сообщество
DocOps-митап начинается с доклада о том, как вести репозиторий с документацией. Рассказывает Константин Валеев, сотрудник Ростелекома и один из авторов Foliant.
источник

EB

Elena Baskakova in DocOps-сообщество
ID:
DocOps-митап начинается с доклада о том, как вести репозиторий с документацией. Рассказывает Константин Валеев, сотрудник Ростелекома и один из авторов Foliant.
Трансляции до сих пор нет(
источник

NV

Nick Volynkin in DocOps-сообщество
Elena Baskakova
Трансляции до сих пор нет(
у меня началась
источник

EB

Elena Baskakova in DocOps-сообщество
Nick Volynkin
у меня началась
Только сейчас
источник

NV

Nick Volynkin in DocOps-сообщество
Привет всем, кто присоединился к чату! Задавайте сюда вопросы, их будут читать после доклада. Заодно подписывайтесь на @docops. :)
источник

NV

Nick Volynkin in DocOps-сообщество
Введение: исходники документации храним в репозитории, коммиты собирает Jenkins (GitLab, Travis, любой другой CI), из документации собираем один или несколько таргетов. Репозиторий в системе контроля версий — это Git, Mercurial или SVN. В них есть ветки. Когда веток много, нужны правила, как с ними работать. Вот о правилах и поговорим.
источник

NV

Nick Volynkin in DocOps-сообщество
Самый популярный набор правил — [git flow](https://github.com/nvie/gitflow).
источник

NV

Nick Volynkin in DocOps-сообщество
Вот как-то так.
источник

NV

Nick Volynkin in DocOps-сообщество
master - опубликованная версия документа
develop - в работе и ждёт публикации
фичеветки - отдельные задачи.

Два этапа ревью: 1) при мерже в develop ревьюит Subject Matter Expert. 2) При мерже в master ревьюит редактор.
источник

НН

Нац Нац in DocOps-сообщество
Гудлак хэвфан всем на митапе, зырну вас на выхах
источник

NV

Nick Volynkin in DocOps-сообщество
Git Flow подходит для сложных и очень ответственных документов с редкими релизами, особенно для внешней документации. Но плохо подходит для внутренней доки, потому что неясно, где же самая актуальная версия, а она нужна.
источник

КС

Кирилл Со in DocOps-сообщество
Nick Volynkin
Git Flow подходит для сложных и очень ответственных документов с редкими релизами, особенно для внешней документации. Но плохо подходит для внутренней доки, потому что неясно, где же самая актуальная версия, а она нужна.
Можешь привести примеры доков?
источник