Size: a a a

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

2018 November 01

NV

Nick Volynkin in DocOps-сообщество
А если узкое место на стороне платного сервиса — печаль.
источник

NV

Nick Volynkin in DocOps-сообщество
У меня была подобная история в 2ГИСе, ускоряли сборку-установку сервиса. Из C++ в работающий и сконфигурированный сервер. И мы там последовательно искали и устраняли узкие места: автоматизировали всё ручное, добавили кеш компилятора, докинули ресурсов на сборочную машину. Было два часа, стало 10-15 минут.
источник

I

Igor in DocOps-сообщество
гавное чтобы  докиуть ресурсов в ci не вышло дороже расширения узкого места платного сервиса
источник

NV

Nick Volynkin in DocOps-сообщество
Igor
гавное чтобы  докиуть ресурсов в ci не вышло дороже расширения узкого места платного сервиса
я у них вообще не вижу такой услуги в ценах https://readme.io/pricing/
источник
2018 November 02

NV

Nick Volynkin in DocOps-сообщество
Igor
гавное чтобы  докиуть ресурсов в ci не вышло дороже расширения узкого места платного сервиса
Ну и за докидыванием ресурсов куда больше контроля. Не помогло — уберём обратно. Или отпрофилируем и найдём где оптимизировать.
источник

OI

Olga Ilchukova in DocOps-сообщество
Nick Volynkin
И когда CI станет узким местом, вы в него просто докинете ресурсов или разделите документацию на куски поменьше.
На мой взгляд, вся проблема этого мероприятия в том, кто будет этим всем заниматься, разбираться и контролировать. Если будет ресурс, девопс какой-нибудь, то проблем нет, тогда self-hosted в радость.
источник

NV

Nick Volynkin in DocOps-сообщество
Olga Ilchukova
На мой взгляд, вся проблема этого мероприятия в том, кто будет этим всем заниматься, разбираться и контролировать. Если будет ресурс, девопс какой-нибудь, то проблем нет, тогда self-hosted в радость.
Согласен.
источник
2018 November 07

RT

Roman Tsirulnikov in DocOps-сообщество
Коллеги поделитесь пожалуйста подходами как можно OpenAPI3 файл спецификации превратить в PDF? Есть готовые инструменты?
источник

NV

Nick Volynkin in DocOps-сообщество
Roman Tsirulnikov
Коллеги поделитесь пожалуйста подходами как можно OpenAPI3 файл спецификации превратить в PDF? Есть готовые инструменты?
@Lananovikova, Nik  — вроде по вашей части вопрос
источник

L

Lana in DocOps-сообщество
Roman Tsirulnikov
Коллеги поделитесь пожалуйста подходами как можно OpenAPI3 файл спецификации превратить в PDF? Есть готовые инструменты?
мы превращаем в rst из него html сфинксом, соответственно можно вместо make html сделать латехом make latexpdf. Также есть вот такая тулза(https://github.com/Swagger2Markup/swagger2markup) она делает md/asciidoc из них тоже можно делать pdf, но не уверена, что она умеет в openapi3.0
источник

НС

Никита Самохвалов in DocOps-сообщество
Нашёл такую штуку: https://www.npmjs.com/package/swagger-spec-to-pdf. Но я сам этим не пользовался, да и есть подозрение, что он только вторую версию спеки понимает.

Если вам просто по фану надо сделать ПДФ, то можно используя существующий инструментарий сгенерировать лендинг документации, а потом натравить на лендинг краулер, который страницу пересохранит в ПДФ.

Но скорее всего вам нужен ПДФ в конкретном формате, а значит надо будет прописать свою логику сборки готового документа. Проще набросать скриптик, использующий любую годную либу для генерации ПДФ, как мне кажется.
источник

RT

Roman Tsirulnikov in DocOps-сообщество
Спасибо, я пробовал эти инструменты, готовый файл документации получается плохой. Выглядит некрасиво, отсутствуют определения объектов.

Попробовал https://github.com/openapitools/openapi-generator
результат такой же плохой
источник

RT

Roman Tsirulnikov in DocOps-сообщество
источник

RT

Roman Tsirulnikov in DocOps-сообщество
В результате получил single  HTML file, но выглядит он хорошо, отображается корректно, все части схемы на месте.
Хоть и не PDF, но для отдачи партнерам годится.
источник

RT

Roman Tsirulnikov in DocOps-сообщество
Коллеги, в этом чате я видел ссылки на инструмент/формат reStructuredText.
Чем он примечателен, для чего используете?

Прокомментируйте пожалуйста выбор инструмента Asciidoctor (https://asciidoctor.org/) в качестве интсрумента/формата ведения технической документации, какие проблемы с ним у вас были? Чем хорош?
источник

DB

Dima Boger in DocOps-сообщество
Roman Tsirulnikov
Коллеги, в этом чате я видел ссылки на инструмент/формат reStructuredText.
Чем он примечателен, для чего используете?

Прокомментируйте пожалуйста выбор инструмента Asciidoctor (https://asciidoctor.org/) в качестве интсрумента/формата ведения технической документации, какие проблемы с ним у вас были? Чем хорош?
Используем rst, потому что он идёт в комплекте с сфинксом, а сфинкс няша
От rst не больно, в нём почти всё логично (кроме ссылок, наверное...)
источник

RT

Roman Tsirulnikov in DocOps-сообщество
расскажете что-такое сфинкс?
источник

DB

Dima Boger in DocOps-сообщество
генератор статических сайтов, его использует документация python и абсолютное большинство python-библиотек
источник

DB

Dima Boger in DocOps-сообщество
Roman Tsirulnikov
Спасибо, я пробовал эти инструменты, готовый файл документации получается плохой. Выглядит некрасиво, отсутствуют определения объектов.

Попробовал https://github.com/openapitools/openapi-generator
результат такой же плохой
Я бы сделал генерацию html'a через оригинальный swagger-codegen:
https://github.com/swagger-api/swagger-codegen#generating-static-html-api-documentation
а потом
html to pdf
любым инструментом
источник

L

Lana in DocOps-сообщество
да его и используем в комплекте со сфинксом
источник