Size: a a a

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

2019 September 03

DE

Daniel Ershov in DocOps-сообщество
Nick Volynkin
rst_epilog который?
Вроде нет, увы сейчас не рядом с сорцами, не смогу глянуть, позже
источник

DE

Daniel Ershov in DocOps-сообщество
Там действительно несколько способов, но корректно заработал только один
источник

DE

Daniel Ershov in DocOps-сообщество
Не все можно питоном собирать))
источник

a

arvikon in DocOps-сообщество
Nick Volynkin
В Jekyll классные инклюды, в них можно передавать данные. Типа так:
{% for record in changelog_records %}
 {% include changelog content=record %}
{% endfor %}
Jekyll вообще классный ;)
источник

NV

Nick Volynkin in DocOps-сообщество
arvikon
Jekyll вообще классный ;)
Нуу, у него есть свои серьёзные ограничения. Например, он однопоточный, и когда собираешь им десятки тысяч страниц, получается долго (у нас было 20-30 минут). Инкрементальная сборка есть, но она бажная: реагирует только на изменения шаблона, но не на изменения данных. В итоге мы используем инкрементальную сборку, но на многих страницах в метаданных проставили regenerate: true
источник

NV

Nick Volynkin in DocOps-сообщество
По сравнению с ним Hugo супербыстрый.
источник

NV

Nick Volynkin in DocOps-сообщество
Ещё Jekyll, кажется, не умеет проверять целостность ссылок, хотя бы внутренних. А на большом масштабе это очень нужно.
источник

a

arvikon in DocOps-сообщество
Nick Volynkin
Нуу, у него есть свои серьёзные ограничения. Например, он однопоточный, и когда собираешь им десятки тысяч страниц, получается долго (у нас было 20-30 минут). Инкрементальная сборка есть, но она бажная: реагирует только на изменения шаблона, но не на изменения данных. В итоге мы используем инкрементальную сборку, но на многих страницах в метаданных проставили regenerate: true
Тут кроется суть всех инструментов - для кого-то ограничения, а кому-то они не мешают жить.
источник

a

arvikon in DocOps-сообщество
Nick Volynkin
Ещё Jekyll, кажется, не умеет проверять целостность ссылок, хотя бы внутренних. А на большом масштабе это очень нужно.
Мы после генерации доки проверяем html-proofer'ом, как внешние, так и внутренние. Если плохо, билд валится, ошибки - в лог.
источник

NV

Nick Volynkin in DocOps-сообщество
arvikon
Мы после генерации доки проверяем html-proofer'ом, как внешние, так и внутренние. Если плохо, билд валится, ошибки - в лог.
источник

a

arvikon in DocOps-сообщество
Да
источник

NV

Nick Volynkin in DocOps-сообщество
Его там можно прямо в Jekyll встроить: https://github.com/gjtorikian/html-proofer#using-with-jekyll
источник

NV

Nick Volynkin in DocOps-сообщество
Ну, точнее, поставить рядом в один пайплайн сборки
источник

ID

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

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

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

NV

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

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

Как маркдаун преобразовать в confluence html формат и залить по апи я разобрался, а вот как удобнее всего хранить маппинг есть сомнения
У меня Sphinx и расширение https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/.
Там задаётся только корневой документ и в него пушится всё дерево документов, начиная с index.

Но в Sphinx по умолчанию reStructuredText, хотя можно добавить и markdown с помощью m2r
источник

NV

Nick Volynkin in DocOps-сообщество
Если придётся пушить несколько отдельных, не связанных иерархически, документов, тогда я буду делать под каждый свой проект (т.е. отдельный conf.py).
источник

NV

Nick Volynkin in DocOps-сообщество
@SuckMyNuts ты там недавно писал про MD→Confluence. Пробовал? Можешь что-нибудь ответить на вопрос выше про маппинг?
источник

НН

Нац Нац in DocOps-сообщество
Nick Volynkin
@SuckMyNuts ты там недавно писал про MD→Confluence. Пробовал? Можешь что-нибудь ответить на вопрос выше про маппинг?
Там было про zendesk вроде, но не, не пробовал
источник

NV

Nick Volynkin in DocOps-сообщество
Нац Нац
Там было про zendesk вроде, но не, не пробовал
это было про pandoc https://pandoc.org/releases.html
источник

НН

Нац Нац in DocOps-сообщество
Nick Volynkin
это было про pandoc https://pandoc.org/releases.html
Точняк
источник