ДС
Size: a a a
2019 February 04
ДС
в гитлаб надо кормить с ```plantuml а не puml
не помогло
ДС
это уже надо своих админов трясти, к ним вопрос
L
В гитлабе надо сервер plantuml поднимать
Сначала
Сначала
ДС
Luiza
В гитлабе надо сервер plantuml поднимать
Сначала
Сначала
Да, поэтому админам и написал
2019 February 05
SK
Доброго дня! А есть ли у кого опыт использования https://github.com/lord/slate
SK
Для написания статичной документации*
2019 February 06
FM
У меня вопрос. Раньше все диаграммы и прочее я рисовали или Visio или в Draw.io
Решил тут попробовать VScode + markdown+mermaid/flowchart и результат мен не порадовал.
Например в mermaid нельзя свзять subgraphs и тп. Рисовать алгоритмы и диаграммы крайне неудобно.
Какой смысл в данных инструментах? Может я что-то не понимаю?!
Решил тут попробовать VScode + markdown+mermaid/flowchart и результат мен не порадовал.
Например в mermaid нельзя свзять subgraphs и тп. Рисовать алгоритмы и диаграммы крайне неудобно.
Какой смысл в данных инструментах? Может я что-то не понимаю?!
A
@daskain мы когда-то использовали, но, быстро отказались. По ощущениям, он был не слишком удобен в плане поддержки документации в markdown формате, хотя сначала казалось, что это решение
SK
@daskain мы когда-то использовали, но, быстро отказались. По ощущениям, он был не слишком удобен в плане поддержки документации в markdown формате, хотя сначала казалось, что это решение
Вот то-же к этой мысли прихожу.
3 месяца назад появилась идея переехать из Confluence, на что-то другое. Изменения в API были скорее бекэндовые и новые версии выкатывали очень не часто.
3 месяца назад появилась идея переехать из Confluence, на что-то другое. Изменения в API были скорее бекэндовые и новые версии выкатывали очень не часто.
SK
А теперь, когда работа по переносу почти подошла к концу, появился новый функционал + старое API стали обновлять. Теперь, для внесения изменений нужно накидать в md, поднять middleman и только потом в прод
A
@daskain держать API документацию в confluence это ещё то зло, у нас есть одна такая команда, и у меня каждый раз смотря на эту красоту идёт кровь из глаз)
Мы держали свой API в apidoc/jsdoc, сейчас переезжаем постепенно на openapi, причем и фронт и бэк
Мы держали свой API в apidoc/jsdoc, сейчас переезжаем постепенно на openapi, причем и фронт и бэк
NV
@daskain держать API документацию в confluence это ещё то зло, у нас есть одна такая команда, и у меня каждый раз смотря на эту красоту идёт кровь из глаз)
Мы держали свой API в apidoc/jsdoc, сейчас переезжаем постепенно на openapi, причем и фронт и бэк
Мы держали свой API в apidoc/jsdoc, сейчас переезжаем постепенно на openapi, причем и фронт и бэк
на прошлой работе был тестировщиком, писал доки на наш HTTP API табличкой в конфлюенсе.
NV
REST-ом язык не поворачивается назвать тот API. Там было два эндпойнта, на них отправлялись JSON, а уже в них полтора десятка параметров
EN
на прошлой работе был тестировщиком, писал доки на наш HTTP API табличкой в конфлюенсе.
это же больно, нет?
EN
или автоматизация была?
NV
Кать, я писал вручную, ещё даже отмечал там параметры которые в разработке, не на проде. Было сложно, но куда лучше, чем ничего.
A
Мне кажется, что если эндроинтов немного, то лучше уж тогда запилить readme.md или что-то иже с ним, описать как положено и держать это в гите
A
У нас есть такой сервис, мы для него накрутили jsdoc и публикуем доку через артефакты в Jenkins
NV
Теперь я бы сделал так, да 😁