Size: a a a

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

2019 September 03

NV

Nick Volynkin in DocOps-сообщество
Ivan Dudkin
Привет всем. Расскажите, пожалуйста, где вы держите маппинг при синке markdown из репозиториев в конфлюенс и есть ли какие-нибудь инструменты в опенсорсе?

path/to/file/in/repo.md => confluencePageId

Как маркдаун преобразовать в confluence html формат и залить по апи я разобрался, а вот как удобнее всего хранить маппинг есть сомнения
а у вас там одиночные документы или деревья (документ с поддокументами и т.д.)?
источник

ID

Ivan Dudkin in DocOps-сообщество
Nick Volynkin
а у вас там одиночные документы или деревья (документ с поддокументами и т.д.)?
/README.md и /docs/**/*.md

что такое поддокумент в контексте маркдауна?
источник

NV

Nick Volynkin in DocOps-сообщество
Ivan Dudkin
/README.md и /docs/**/*.md

что такое поддокумент в контексте маркдауна?
я имел в виду child document в контексте конфлюенса
источник

ID

Ivan Dudkin in DocOps-сообщество
Я пробовал агрегировать доки в один большой при экспорте с виджетом вертикальных табов, но мне не понравилось

Хочется простую разметку в конфлюенсе, что бы можно было легко экспортировать в пдф
источник

ID

Ivan Dudkin in DocOps-сообщество
Т.е. да, нужно дерево в конфлюенсе)
источник

NV

Nick Volynkin in DocOps-сообщество
Ну тогда вы можете пойти через Sphinx: выстроить дерево в файлах .rst, в них поинклюдить контент из файлов md, и всё это одной командой пушить.
источник

NV

Nick Volynkin in DocOps-сообщество
фрагмент conf.py:

extensions = [
   'sphinxcontrib.confluencebuilder',
   'm2r'
   ]

confluence_publish = True
confluence_space_name = 'SPACENAME'
confluence_server_url = 'https://wiki.example.com'
confluence_server_user = 'username'
confluence_parent_page = "Root Document"
confluence_ask_password = True
confluence_page_hierarchy = True
confluence_disable_notifications = True
источник

NV

Nick Volynkin in DocOps-сообщество
Ivan Dudkin
Я пробовал агрегировать доки в один большой при экспорте с виджетом вертикальных табов, но мне не понравилось

Хочется простую разметку в конфлюенсе, что бы можно было легко экспортировать в пдф
табы в PDF плохо работают, да )
источник

ID

Ivan Dudkin in DocOps-сообщество
а как он в итоге матчит локальные пути с айдишниками? Просто по названию?
источник

NV

Nick Volynkin in DocOps-сообщество
По заголовкам документов.

То есть если у меня есть example.rst и в нём первый заголовок "Example Document", то в конфлюенсе будет такой же документ "Example Document"
источник

NV

Nick Volynkin in DocOps-сообщество
Пока не смотрел, что получается при переименовании. Вероятно, создаст новый документ и удалит старый (если включён конфиг confluence_purge = True).
А может и переименует, если файл остался тем же и окружение не очищалось после предыдущей сборки. Надо проверить )
источник

ID

Ivan Dudkin in DocOps-сообщество
Спасибо 👍
источник

NV

Nick Volynkin in DocOps-сообщество
Also, есть техническая тонкость. При каждой публикации Sphinx обновляет всё дерево, каждую страницу. Даже если контент не менялся, создаётся пустая правка. Это много активности, она может засорять какой-нибудь канал.

Например, у нас в Plesk на кухне телевизор показывает в том числе недавние обновления в Confluence, так вот я сегодня его заовнил на некоторое время. :)
источник

NK

ID:0 in DocOps-сообщество
Докеризованный Pandoc и куча фильтров Pandoc для разных задач: https://github.com/pandocker
источник

KC

Kseniya Chudakova in DocOps-сообщество
ID:
Докеризованный Pandoc и куча фильтров Pandoc для разных задач: https://github.com/pandocker
кайф
источник

DE

Daniel Ershov in DocOps-сообщество
Nick Volynkin
rst_epilog который?
да
источник

DE

Daniel Ershov in DocOps-сообщество
Nick Volynkin
Пока не смотрел, что получается при переименовании. Вероятно, создаст новый документ и удалит старый (если включён конфиг confluence_purge = True).
А может и переименует, если файл остался тем же и окружение не очищалось после предыдущей сборки. Надо проверить )
никогда не включайте confluence_purge, он зачищает соседние папки
источник

NV

Nick Volynkin in DocOps-сообщество
Daniel Ershov
никогда не включайте confluence_purge, он зачищает соседние папки
да, поэтому я его направляю не на спейс целиком, а на отдельную папку, внутри которой всё и происходит
источник

DE

Daniel Ershov in DocOps-сообщество
полдня продуктивной работы в помойку тогда ушло...
хорошо что бэкап конфы в тот день был
источник

DE

Daniel Ershov in DocOps-сообщество
Nick Volynkin
да, поэтому я его направляю не на спейс целиком, а на отдельную папку, внутри которой всё и происходит
я тоже на отдельную папку
источник