Size: a a a

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

2021 May 17

J

Jonny Cuba in DocOps-сообщество
Пока не знаю, но возможно будут
источник

J

Jonny Cuba in DocOps-сообщество
По задаче, хочу интегрировать процесс документирования, в текущий процесс разработки ПО
источник

NV

Nick Volynkin in DocOps-сообщество
Во, это важно. Нужен ли там сложный контент внутри (как блоки кода или списки), нужно ли объединение ячеек.
источник

J

Jonny Cuba in DocOps-сообщество
Списки точно будут. С таблицами сложнее, пока неизвестно, но не хотелось бы испытывать сложностей с ними
источник

J

Jonny Cuba in DocOps-сообщество
да, еще будут схемы, которые рисуют аналитики и архитекторы, вот это тоже важно при выборе, должна быть возможность хранить не картинки, а редактировать их. смотрю на  plantUML + markdown
источник

ME

Maria Ermakovich in DocOps-сообщество
mermaid.js можно в docusaurus встроить есличо
источник

J

Jonny Cuba in DocOps-сообщество
ни то, ни другое еще не использовал, посмотрю, спасибо!
источник

ME

Maria Ermakovich in DocOps-сообщество
докузавр берите второй, если захотите с ним связаться)
источник

AN

Andrew Nilove 💔 in DocOps-сообщество
#вопрос

У меня на текущем проекте существует около 35 микросервисов разной степени упоротости. Причем ни в одном из них не применяется кодогенерация на Swagger, в лучшем случае есть Spring REST Docs простой с кучей тестов и то не во всех. Прям боль боль.
Встречались ли в практике какие-либо шаблоны репозитариев или плагины, которые бы сравнительно быстро позволили перевести весь этот колхоз на кодогенерацию со Swagger? Потому что ручками переводить врядли получится убедить команды.
источник

AN

Andrew Nilove 💔 in DocOps-сообщество
Как варик посоветовали попробовать развесить аннотации на код и запустить springfox. Отзовитесь, кто пользовал пожалуйста.
источник

J

Jonny Cuba in DocOps-сообщество
😄👌хорошо
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
Да, я писал, мы этим пользуемся. Разработчики сами инициировали (редкий случай). Единственное, я немного ругался, когда json-файл не соответствовал Open API (по факту часто оказывалось, что из-за ошибок в коде).
источник

AN

Andrew Nilove 💔 in DocOps-сообщество
сейчас поищу выше по чату
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
там где-то совсем высоко))
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
собственно ругался-то я потому, что когда готовил документацию заказчику, процессор в Asciidoc ругался, что не может обработать исходный файл... так-то вообще бы молчал
источник

J

Jonny Cuba in DocOps-сообщество
Посмотрел asciidoc, интересно, без плясок  сгенерировал несколько форматов документов  Подскажи с таблицами там проблем нет? Схемами? Например, plantuml поддерживает, чтобы можно было править сразу в коде? Может какие то свои  решения для схем есть?
источник

RG

Ramil G in DocOps-сообщество
Plantuml отлично эмбеддится. Также можно встраивать схемы drawio в виде png
источник

RG

Ramil G in DocOps-сообщество
Первый рендерится через кроки (kroki)
источник

J

Jonny Cuba in DocOps-сообщество
О, спасибо, png не подходит, надо чтобы аналитики сразу могли править
источник

VA

Viktor Alexandrov in DocOps-сообщество
есть где поглядеть?
источник