Size: a a a

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

2018 December 04

NV

Nick Volynkin in DocOps-сообщество
Hanna
добрый день, чат! а есть здесь кто-нибудь, кто использует статический генератор сайтов middleman, и при этом публикает документацию не на github pages?
@factorized вроде у тебя был middleman?
источник

NV

Nick Volynkin in DocOps-сообщество
Hanna
добрый день, чат! а есть здесь кто-нибудь, кто использует статический генератор сайтов middleman, и при этом публикает документацию не на github pages?
Расскажите, какая задача?
источник

H

Hanna in DocOps-сообщество
Задача — найти инструмент для красивой API документации. Наткнулась на вот такой проект https://github.com/lord/slate, выглядит красиво, но смущает генератор на ruby, и что "нативная" совместимость только с github pages. Было бы здорово узнать, есть ли успешные кейсы применения middleman на реальных проектах с публикацией документации, например, через docker контейнер. Потому что если нет, то скорее всего будет нецелесообразно лезть разбиираться  🙂
источник

ИУ

Илья Улеско in DocOps-сообщество
Hanna
Задача — найти инструмент для красивой API документации. Наткнулась на вот такой проект https://github.com/lord/slate, выглядит красиво, но смущает генератор на ruby, и что "нативная" совместимость только с github pages. Было бы здорово узнать, есть ли успешные кейсы применения middleman на реальных проектах с публикацией документации, например, через docker контейнер. Потому что если нет, то скорее всего будет нецелесообразно лезть разбиираться  🙂
Swagger?
источник

H

Hanna in DocOps-сообщество
swagger уже есть
источник

NV

Nick Volynkin in DocOps-сообщество
Hanna вы его хотите заменить или дополнить?
источник

H

Hanna in DocOps-сообщество
дополнить!
источник

NV

Nick Volynkin in DocOps-сообщество
Про публикацию через docker: это отдельная задача, она не связана с тем, какой инструмент вы используете. Грубо говоря, любой генератор статических сайтов выдаёт вам файлы HTML+CSS+JS. Потом вы берёте стандартный образ nginx:latest, добавляете в него файлы и запечатываете в новый образ. Всё, документация в докере готова.
источник

H

Hanna in DocOps-сообщество
@Nick_Volynkin спасибо за помощь! может, и стоит попробовать)
источник

NV

Nick Volynkin in DocOps-сообщество
Hanna
дополнить!
A расскажите, пожалуйста, подробней. Чем вы хотите дополнить swagger?
источник

NV

Nick Volynkin in DocOps-сообщество
Вы хотите кроме API reference ещё написать про смысл и то как использовать API? Tutorials, quickstart guide, вот это всё?
источник

СФ

Семён Факторович in DocOps-сообщество
Nick Volynkin
@factorized вроде у тебя был middleman?
да, я на нем статические сайты делаю (documentat.io тоже на нем сделан, кстати), но паблишу всё на github pages
источник

СФ

Семён Факторович in DocOps-сообщество
вообще какой-то привязки к github pages у него нет, он на выход отдает просто пачку HTML и статических ассетов (css, js)
источник

NV

Nick Volynkin in DocOps-сообщество
@factorized а ты деплоишь через ветку gh-pages, так?
источник

СФ

Семён Факторович in DocOps-сообщество
это можно публиковать куда угодно, хоть на S3, хоть в докер-контейнер с nginx-ом заворачивать
источник

СФ

Семён Факторович in DocOps-сообщество
Nick Volynkin
@factorized а ты деплоишь через ветку gh-pages, так?
да
источник

СФ

Семён Факторович in DocOps-сообщество
Семён Факторович
это можно публиковать куда угодно, хоть на S3, хоть в докер-контейнер с nginx-ом заворачивать
хоть по старинке на физический железячный сервер выложить:)
источник

H

Hanna in DocOps-сообщество
Nick Volynkin
Вы хотите кроме API reference ещё написать про смысл и то как использовать API? Tutorials, quickstart guide, вот это всё?
да, да
источник

H

Hanna in DocOps-сообщество
@factorized спасибо!
источник

NV

Nick Volynkin in DocOps-сообщество
Hanna
да, да
тогда предлагаю вам выбрать SSG по таким критериям:
— написан на языке, на котором у вас есть разработчики. Вот Руби вам именно этим не подходит, да?
— из коробки есть тема (шаблон) оформления, которая вам нравится
источник