Size: a a a

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

2020 August 19

EP

Elena Parameshwari in DocOps-сообщество
Всем доброе утро! Коллеги, нужен совет по организации работы Markdown + Git + три версии продукта в "разработке" паралелльно. Мне кажется, я не вывожу то, что происходит.

Ситуация такая - есть продукт, на него ведем "часть документации" в markdown. Храним все в собственном git-хранилище. Каждая страница документации имеет два варианта (рабочее описание и описание, которое войдет в релиз). Решили таким образом отслеживать изменения, требующие документирования. Когда разработчик обновляет свою часть описания, добавляется "файл-маркер", по которому я понимаю, что описание обновлено и требует "доработки". Проблемы начинаются, когда мне предложили правку между ветками "переносить cherry-pick-ами". Продукт "относительно" новый, но уже три ветки разработки и меня напрягает, что могу тупо запутаться в такой схеме при переносе (например, я переношу из 2ой версии в 3ю документацию к публикации, а в 3-ей версии что-то поправили (а свои файлы-маркеры я не перетаскиваю).
Сейчас я редактирую все в своей ветке (например 2-edit), и вливаю изменения в основное хранилище, и потом этот коммит (которым я вливаю 2 -edit в 2 ) я пытаюсь перетащить в 3 и 4 "редакции".

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

ML

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

DB

Dima Boger in DocOps-сообщество
Elena Parameshwari
Всем доброе утро! Коллеги, нужен совет по организации работы Markdown + Git + три версии продукта в "разработке" паралелльно. Мне кажется, я не вывожу то, что происходит.

Ситуация такая - есть продукт, на него ведем "часть документации" в markdown. Храним все в собственном git-хранилище. Каждая страница документации имеет два варианта (рабочее описание и описание, которое войдет в релиз). Решили таким образом отслеживать изменения, требующие документирования. Когда разработчик обновляет свою часть описания, добавляется "файл-маркер", по которому я понимаю, что описание обновлено и требует "доработки". Проблемы начинаются, когда мне предложили правку между ветками "переносить cherry-pick-ами". Продукт "относительно" новый, но уже три ветки разработки и меня напрягает, что могу тупо запутаться в такой схеме при переносе (например, я переношу из 2ой версии в 3ю документацию к публикации, а в 3-ей версии что-то поправили (а свои файлы-маркеры я не перетаскиваю).
Сейчас я редактирую все в своей ветке (например 2-edit), и вливаю изменения в основное хранилище, и потом этот коммит (которым я вливаю 2 -edit в 2 ) я пытаюсь перетащить в 3 и 4 "редакции".

Переносить правку между версиями совсем руками, кажется довольно трудозатратным. Как лучше поступить (и возможно, можно перестроить сам процесс?)  в подобных случаях?
А у вас фичи свободно мигрируют между тремя версиями? Или всё таки 1->2->3?
источник

EP

Elena Parameshwari in DocOps-сообщество
стараются держаться идеи  1->2->3, но в ветке первой версии могут появиться "фичи из следующей версии", которые стали полезны (такое перемещение уже было, причем в следующей версии они "доработали вновь добавленный механизм")
источник

DB

Dima Boger in DocOps-сообщество
в такой схеме ничего кроме как черипикать и переносить руками не остаётся, причем разработчикам тоже :(

Не представляю какая жуть потом решать конфликты 😱
источник

DB

Dima Boger in DocOps-сообщество
Можно попробовать увести документацию из гита куда-нибудь, чтобы упростить ведение, но ничего внятного я предложить не могу
источник

EP

Elena Parameshwari in DocOps-сообщество
т.е. с гитом вроде бы действительно "относительно понятно," но когда у разработки такие финты я реально теряюсь. В итоге я переношу правку в следующую и все равно отдельно сравниваю "не было ли с тех пор изменений от разработчиков". видимо, единственный вариант при работе по подобной схеме. Спасибо за ответы
источник

ML

Maksim Lapshin in DocOps-сообщество
Elena Parameshwari
т.е. с гитом вроде бы действительно "относительно понятно," но когда у разработки такие финты я реально теряюсь. В итоге я переношу правку в следующую и все равно отдельно сравниваю "не было ли с тех пор изменений от разработчиков". видимо, единственный вариант при работе по подобной схеме. Спасибо за ответы
может быть всё таки документацию держать рядом с исходниками? Тогда они хотя бы будут синхронны
источник

EP

Elena Parameshwari in DocOps-сообщество
сейчас по процессу "синхронизируются" описания от разработчиков (выгружается, по всей видимости, из хранилища с исходниками). и разводили вроде бы для удобства. но при поддержке какой-то треш получается. и что бы "правильно" перенести коммит из предыдущей версии черрипиком я дополнительно сверяю с "текущей версией  описания разработчика", те. получается расширенная версия черрипика)
источник

ML

Maksim Lapshin in DocOps-сообщество
звучит как «гит вручную»
источник

EP

Elena Parameshwari in DocOps-сообщество
у меня пока не получается перенести и быть без доп.проверки уверенной, что дока для 2ой версии будет актуальна для 3-ей (куда переношу), Например. В этом и загвоздка.
источник
2020 August 20

L

Lana in DocOps-сообщество
https://habr.com/ru/company/selectel/blog/514576/ кейс про Hugo от selectel
источник

ML

Maksim Lapshin in DocOps-сообщество
Клево!!
источник

SW

Shayne Woodward in DocOps-сообщество
Главная задача Игры - самостоятельно вспомнить свой сценарий и сыграть свою роль максимально качественно, используя весь потенциал каждой секунды своей земной жизни. Правила Игры Тут
источник

DB

Dima Boger in DocOps-сообщество
Shayne Woodward
Главная задача Игры - самостоятельно вспомнить свой сценарий и сыграть свою роль максимально качественно, используя весь потенциал каждой секунды своей земной жизни. Правила Игры Тут
О, кстати, у них лица сгенерированы через thispersondoesnotexist
источник

DB

Dima Boger in DocOps-сообщество
Достойное применение технологии
источник
2020 August 24

SK

Sergey Khitrin in DocOps-сообщество
Ребята, а есть у кого-то на примете инструменты, которые бы позволяли "тестировать" сгенерированные PDF (md -> latex -> pdf)?
В рамках отладки шаблонов мы меняем сотни документов и где-то может починиться , а где-то - сломаться.

Как вы с этим работаете? Как проводите регрессионное тестирование большого объёма документов?
источник

NV

Nick Volynkin in DocOps-сообщество
Sergey Khitrin
Ребята, а есть у кого-то на примете инструменты, которые бы позволяли "тестировать" сгенерированные PDF (md -> latex -> pdf)?
В рамках отладки шаблонов мы меняем сотни документов и где-то может починиться , а где-то - сломаться.

Как вы с этим работаете? Как проводите регрессионное тестирование большого объёма документов?
А что именно тестировать? Верстку?
источник

SK

Sergey Khitrin in DocOps-сообщество
Nick Volynkin
А что именно тестировать? Верстку?
Да. Верстка, перекрытие текста.
источник

ML

Maksim Lapshin in DocOps-сообщество
Sergey Khitrin
Да. Верстка, перекрытие текста.
Оу.

Полиграфия прожила 400 лет и буквально 10 лет не дожила до prepress-as-a-code
источник