CodeFest: Три истории провалов с Git.

Привет! Впереди конференция CodeFest. Там на стенде компании Plesk будут небольшие доклады от наших ребят.  А я хочу провести там воркшоп о проблемах с Git.

На воркшопе обсудим несколько неочевидных ошибок, почему они происходят, как их решать и предотвращать.  Расскажу немного про то, как внутри устроены коммиты. Решим несколько практических задачек,  получим немного боевого опыта факапов и их починки. В конце вместе пособираем коммиты голыми руками: без использования git, только через Python/Ruby REPL.

Расскажите, стоит ли вообще это делать, придёте ли вы лично?

Я пишу в PyCharm платном, там есть поддержка шаблонов Jinja 2 ещё

А зачем кастомное решение?

Свагер точно умеет, причем в разные аутентификационные схемы. Ещё некоторые распространяют документацию к API в виде импорт-файла для postman и прочих

Поддерживаю, удобнее IntelliJ IDEA и производных для себя пока не нашел

Плагинами можно прикрутить ещё и OpenAPI (Swagger), GraphQL, Markdown есть

Не IDE, а комбайн

Для , Markdown там даже два плагина

Один платный даже вроде как

Кстати, я тут открыл для себя redoc

https://rebilly.github.io/ReDoc/ и мне нравится

дискриминаторы ❤️

В одном из наших проектов есть огромный массив документации в GitBook. В скором будущем нам надо будет добавлять туда описание небольшого RESTful HTTP API, и мы хотим сделать это бесшовно, оставаясь в гитбуке

Вы же можете врезать страницы со сваггером просто

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

:O

у меня с ходу было ощущение, что это довольно костыльный путь, поэтому и хочется посмотреть, как это делают другие

ну заинклюдить как-нибудь raw html

текущая гипотеза в том, что чем сопрягать ежа с ужом, лучше все-таки сделать кастомное решение

но, возможно, мы героически придумываем себе трудности

и надо брать сваггер и не выпендриваться

в общем, возвращаясь к изначальному вопросу, есть ли примеры такой документации, но _не_ в сваггере?