Size: a a a

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

2021 November 19

KC

Konstantin Chukhlomi... in DocOps-сообщество
А есть где-то в открытом доступе код до и после? Хотелось бы посмотреть
источник

DL

Dmytro Lispyvnyi '(🌲... in DocOps-сообщество
лично у меня сейчас даже в закрытом нет, с июня там не работаю :)

а так: шаблонизация элементарна как 3 копейки, вычитал шаблон, сгенерировал хэшмапу c с данными к нему, свернул - и вот выхлоп :)
источник

DL

Dmytro Lispyvnyi '(🌲... in DocOps-сообщество
можем на конкретных примерах рассмотреть, но лучше в привате и уже завтра
источник

ML

Maksim Lapshin in DocOps-сообщество
разница есть конечно.

Только вопрос не совсем и не столько про скачивание туда-сюда, а про суммарную кумулятивную скорость CI.

Если сборка занимает больше 2-3 минут, теряется интерактивность.

Если прогон CI занимает более четверти часа, то это просто фиаско.
источник

IC

Ivan Cheban in DocOps-сообщество
Я тестировал разные генераторы, но самый быстрый это Hugo, который на Go
источник

IC

Ivan Cheban in DocOps-сообщество
Константин, спасибо за новый генератор! А можно на нем генерировать не блог, а сайт с документацией?
источник

RG

Ramil G in DocOps-сообщество
Спасибо! Интересно было изучить.
источник

VS

Vadim Smelyanskiy in DocOps-сообщество
Если даже базовый контейнер с Java весит сотни мегабайт, у Докера всё ещё слои в файловой системе, и слой с изменением .jar весить будет совсем чуть-чуть
источник

KC

Konstantin Chukhlomi... in DocOps-сообщество
В принципе, ничего не мешает генерировать и сайт с документацией. У genblog нюанс в том что он сортирует все посты по дате публикации. Для документации я бы взял mkdocs  https://www.mkdocs.org (Python) + https://squidfunk.github.io/mkdocs-material/
там и поиск, и разные полезные расширения типа Admonitions, Abbreviations, mermaid, …
источник

IC

Ivan Cheban in DocOps-сообщество
Есть несколько генераторов для документации. Самый простой Docusaurus. Мой самый любимый на Hugo тема Docsy.
источник
2021 November 21

V

Vasiliy in DocOps-сообщество
Такой вопрос. Есть большой и несколько запутанный проект на Sphinx. Появилось желание построить карту статей и взаимных ссылок. Есть ли готовые инструменты для этого?
источник

NV

Nick Volynkin in DocOps-сообщество
Можно получить список ссылок внутри и вне документации. Для этого собери доки с таргетом linkcheck.  Если дефолтный Makefile используется, то make linkcheck.
источник

NV

Nick Volynkin in DocOps-сообщество
Но вообще, надо сделать такую штуку )
источник

V

Vasiliy in DocOps-сообщество
Благодарю. linkcheck оказался очень полезен.

Тоже склоняюсь к тому, что можно и написать самому)
источник

NV

Nick Volynkin in DocOps-сообщество
там в общем-то нужно распарсить вывод linkcheck и как-то визуализировать полученный граф
источник

NV

Nick Volynkin in DocOps-сообщество
сколько битых ссылок нашлось? ))
источник

V

Vasiliy in DocOps-сообщество
Что-то не вижу в конечном выводе подсчёт битых ссылок. Но визуально уже больше десяти
источник

NV

Nick Volynkin in DocOps-сообщество
подсчета там вроде и нет
источник

DB

Dima Boger in DocOps-сообщество
а он разве смотрит cross reference внутри?
источник

V

Vasiliy in DocOps-сообщество
у меня сейчас 'linkcheck' нашел ошибки в якорях (anchor), так что, видимо, и внутренние тоже.
источник