Докер? Не умею с ним, но видел вот https://hub.docker.com/r/klakegg/hugo

.

Gitlab ci, я просто взяла из реджистри самого Hugo, а у docsy в зависимостях postcss и autoprefixer

Имаж этот прям под докси, там даже приписано это. Нашёл в ишшью к репе

Я попробовала hugo_extended Ругается, что нет postcss. Похожу придётся свой собирать и npm install

Я попробую с ним щас, спасибо

Коллеги, привет!

Поделитесь плз опытом, мб у кого-то уже был такой кейс.

Есть продукт, у продукта есть API. Документация у продукта в Confluence, включая документацию API.
Есть мысли автоматизировать документирование API следующим образом:
1. Разработчик API в процессе пишет комменты в коде неким согласованным образом, по какому-то шаблону;
2. Дальше мы собираем эти комменты, скармливаем их какому-нибудь условному phpdoc (первое, что пришло в голову, скорее всего, есть варианты лучше);
3. Из скормленной ранее документации формируется HTML и постится в заданный раздел в Confluence.

Возможно, мы мыслим не в том направлении, и стоит делать проще)

а API какой? RESTful HTTP?

Привет. Хах, Семён меня определил с вопросом.

@Nick_Volynkin о, пока не забыл: а можно мне плашку «наем и профессиональное развитие техписателей»?

многабукаф)

Так, а где тут очередь за плашками)

немного интереснее
есть JS API для использования в скриптах, пишущихся в рамках платформы
и есть REST API
концепция похожа на API ServiceNow (https://developer.servicenow.com/app.do#!/api_doc?v=newyork&id=no-namespace)

для RESTful надо брать OpenAPI, т.к. вокруг него самая богатая экосистема инструментария

+

т.е. цепочка может быть такой:
- комментарии к методам в коде
- их автоматическое выгребание и формирование по ним OpenAPI-спецификации
- конвертация OpenAPI во что-нибудь промежуточное, например, в Markdown
- публикация из Markdown чего угодно в каком угодно формате (HTML, импорт md в Confluence, и т.д.)

OpenAPI, спасибо, попробуем
для не-RESTful подобного  инструментария нет под рукой?)

У нас api документируется в swagger

ещё один вариант, спасибо, посмотрим, насколько он у нас применим

swagger — это коллекция инструментов в экосистеме OpenAPI