Size: a a a

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

2019 June 01

НН

Нац Нац in DocOps-сообщество
Bogdan (SirEdvin) Gladyshev
Хм ... и еще такой странный вопрос. У меня планируется довольно большое количество self-hosted sphinx документации в html формате. Кроме самостоятельной магии с nginx и readthedocs есть еще какие-то self-hosted альтернативы, куда можно деплоить html сайтики?
источник

NV

Nick Volynkin in DocOps-сообщество
Bogdan (SirEdvin) Gladyshev
Хм ... и еще такой странный вопрос. У меня планируется довольно большое количество self-hosted sphinx документации в html формате. Кроме самостоятельной магии с nginx и readthedocs есть еще какие-то self-hosted альтернативы, куда можно деплоить html сайтики?
Readthedocs можно самому хостить
источник

BG

Bogdan (SirEdvin) Gladyshev in DocOps-сообщество
Это понятно, но мне нужно что-то типо netlify скорее...
источник

NV

Nick Volynkin in DocOps-сообщество
Amazon S3?
источник

NV

Nick Volynkin in DocOps-сообщество
И сверху закрыть CDN'ом
источник

V

Vanger in DocOps-сообщество
Bogdan (SirEdvin) Gladyshev
Хм ... и еще такой странный вопрос. У меня планируется довольно большое количество self-hosted sphinx документации в html формате. Кроме самостоятельной магии с nginx и readthedocs есть еще какие-то self-hosted альтернативы, куда можно деплоить html сайтики?
докер+nginx с запиленым CD работает на ура
источник

BG

Bogdan (SirEdvin) Gladyshev in DocOps-сообщество
Ну вот да ( )
источник
2019 June 03

AS

Anastasiya Selivanava in DocOps-сообщество
Всем приветики. Вопрос к тем, кто занимается описанием API и использует Swagger.
Разрабы генерируют мне swagger file. Я там всё красиво пишу и редактирую, добавляю-обновляю и заливаю на дев. портал.
Проблема в том, что в коде остаются старые, некрасивые описания.
Вопрос: каким образом сделать так, чтобы и в код попадали описания, отредактированные мною?
А) Может быть, мне стоит править описание API методов прямо в коде и уже потом генерировать swagger file?
Б) Или же можно каким-то образом залить swagger file, отредактированный мною, обратно в код?
В) Есть ещё какой-то подход?
источник

A

Antonio in DocOps-сообщество
A)
источник

AR

Anna Ryutina in DocOps-сообщество
Anastasiya Selivanava
Всем приветики. Вопрос к тем, кто занимается описанием API и использует Swagger.
Разрабы генерируют мне swagger file. Я там всё красиво пишу и редактирую, добавляю-обновляю и заливаю на дев. портал.
Проблема в том, что в коде остаются старые, некрасивые описания.
Вопрос: каким образом сделать так, чтобы и в код попадали описания, отредактированные мною?
А) Может быть, мне стоит править описание API методов прямо в коде и уже потом генерировать swagger file?
Б) Или же можно каким-то образом залить swagger file, отредактированный мною, обратно в код?
В) Есть ещё какой-то подход?
встречный вопрос, а зачем оставлять старое описание?
источник

AS

Anastasiya Selivanava in DocOps-сообщество
Спасибо! Я тоже так думала, но нужно было убедиться в правильности моего предположения.
источник

A

Antonio in DocOps-сообщество
Anna Ryutina
встречный вопрос, а зачем оставлять старое описание?
+1
источник

AS

Anastasiya Selivanava in DocOps-сообщество
Anna Ryutina
встречный вопрос, а зачем оставлять старое описание?
В том то и смысл, что я не хочу оставлять старые описания. Но изначально разрабы не хотели пускать меня в код. Генерировали мне swagger file, я его редактировала — и разрабы чувствовали себя в безопасности 😂
источник

AS

Anastasiya Selivanava in DocOps-сообщество
Но в коде оставались старые описания.
источник

I

Igor in DocOps-сообщество
Anastasiya Selivanava
Всем приветики. Вопрос к тем, кто занимается описанием API и использует Swagger.
Разрабы генерируют мне swagger file. Я там всё красиво пишу и редактирую, добавляю-обновляю и заливаю на дев. портал.
Проблема в том, что в коде остаются старые, некрасивые описания.
Вопрос: каким образом сделать так, чтобы и в код попадали описания, отредактированные мною?
А) Может быть, мне стоит править описание API методов прямо в коде и уже потом генерировать swagger file?
Б) Или же можно каким-то образом залить swagger file, отредактированный мною, обратно в код?
В) Есть ещё какой-то подход?
A
источник

I

Igor in DocOps-сообщество
Прошу прощения, но похоже разрабы просто пытались от вас отмахнуться :(
источник

AR

Anna Ryutina in DocOps-сообщество
Anastasiya Selivanava
В том то и смысл, что я не хочу оставлять старые описания. Но изначально разрабы не хотели пускать меня в код. Генерировали мне swagger file, я его редактировала — и разрабы чувствовали себя в безопасности 😂
если вы работаете в гите, то там можно поддерживать версионность
источник

A

Antonio in DocOps-сообщество
Anastasiya Selivanava
Спасибо! Я тоже так думала, но нужно было убедиться в правильности моего предположения.
В нашем случае, я пишу доки не в коде, а в отдельной папке для сваггера, которая повторяет структуру source файлов. Потом есть мидлварь, которая натравливается на индекс файл сваггера, в который включены все файлы и она генерит финальный swagger json, который потом используется в доке
источник

AS

Anastasiya Selivanava in DocOps-сообщество
Igor
Прошу прощения, но похоже разрабы просто пытались от вас отмахнуться :(
Так и было, думаю. Плюс, они ссылаются на то, что у них мало времени на проверку изменений, который я потенциально буду делать.
источник

BG

Bogdan (SirEdvin) Gladyshev in DocOps-сообщество
Anastasiya Selivanava
Всем приветики. Вопрос к тем, кто занимается описанием API и использует Swagger.
Разрабы генерируют мне swagger file. Я там всё красиво пишу и редактирую, добавляю-обновляю и заливаю на дев. портал.
Проблема в том, что в коде остаются старые, некрасивые описания.
Вопрос: каким образом сделать так, чтобы и в код попадали описания, отредактированные мною?
А) Может быть, мне стоит править описание API методов прямо в коде и уже потом генерировать swagger file?
Б) Или же можно каким-то образом залить swagger file, отредактированный мною, обратно в код?
В) Есть ещё какой-то подход?
Сначала писать спеку, а что бы разрабы по ней уже писали код?
источник