Size: a a a

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

2020 December 06

YD

Yuri Dobrev in DocOps-сообщество
Maria
Здравствуйте, может есть у кого типовые, если не жалко..
1.регламент резервного копирования облачных данных
2.регламент техобслуживания и обработки обращений
3.регламент восстановления работоспособности системы в случае сбоя, все для облачных
Спросите в @technicalwriters
источник

NV

Nick Volynkin in DocOps-сообщество
Maria
Здравствуйте, может есть у кого типовые, если не жалко..
1.регламент резервного копирования облачных данных
2.регламент техобслуживания и обработки обращений
3.регламент восстановления работоспособности системы в случае сбоя, все для облачных
Вот кроме шуток, все эти вещи должны бы происходить автоматически. Регламент резервного копирования — это код. Техобслуживание в облаке — вообще не понимаю, со обслуживать, если вычислительные мощности все арендованные. Про обработку обращений непонятно, от кого и про что обращения. Восстановление работоспособности тоже в первую очередь автоматическое.
источник

F

Fagor in DocOps-сообщество
Может облака свои? Тогда берем регламенты по железу и чутка переписываем под софт.
источник

BF

Bobba Fett in DocOps-сообщество
Vadim Smelyanskiy
Хочу плагины к VSCode/IntelliJ IDEA, куда комменты на исходник будут падать
Не понял, вы хотите плагин, который будет из собранного сайта класть комментарии в нужное места исходника? Можно подробнее?
источник

F

Fagor in DocOps-сообщество
Bobba Fett
Не понял, вы хотите плагин, который будет из собранного сайта класть комментарии в нужное места исходника? Можно подробнее?
Да не плагин, если собрать поподробнее, давно витает в воздухе, ide для документов. Полноценное, с привязкой к фреймворкам сборки, но такого нет. Я даже понимаю почему, в чем отличие кода от дока. Тут еще "условную базу данных" прикручивать, прямо в ide. Так еще и в сборке во фронт обратно в базу возвращать некоторые изменения. В общем концепты в головах есть и по кусочкам и цельные, но в спрос никто не верит.
источник

NV

Nick Volynkin in DocOps-сообщество
Maksim Lapshin
да не, вообще не то.

Я зашел на страницу, вижу там багу.

Хочу выделить кусок и написать «тут написана фигня. Эй вы там, разберитесь».

Ответственный техпис видит и правит это
На Хабре и разных других сайтах есть такая фича — выделить кусок текста и прокомментировать для автора. В части документации Гугла есть комментирование параграфов, я даже раз или два засылал им фидбек таким образом.
источник

F

Fagor in DocOps-сообщество
Nick Volynkin
На Хабре и разных других сайтах есть такая фича — выделить кусок текста и прокомментировать для автора. В части документации Гугла есть комментирование параграфов, я даже раз или два засылал им фидбек таким образом.
Нужна база, и возврат из база данных в ide. А так же тегирование объектов. Отдельно правила тегирования. В общем мало кто верит что такой софт будет коммерчески успешен, а работы там на целую эко систему "за миллион", с проеданием денег инвестора конечно, но все равно.
источник

NV

Nick Volynkin in DocOps-сообщество
Fagor
Нужна база, и возврат из база данных в ide. А так же тегирование объектов. Отдельно правила тегирования. В общем мало кто верит что такой софт будет коммерчески успешен, а работы там на целую эко систему "за миллион", с проеданием денег инвестора конечно, но все равно.
А обязательно в IDE? Просто комментарий со ссылкой на файл и строку вас бы не устроил?
источник

NV

Nick Volynkin in DocOps-сообщество
А то комментарии несложно сделать и без миллионных затрат.
источник

F

Fagor in DocOps-сообщество
Nick Volynkin
А обязательно в IDE? Просто комментарий со ссылкой на файл и строку вас бы не устроил?
С тем с чем я работаю, уже нет, реально и без шуток, я вижу что нужно уже большее. В шейр поинте например doc с комментариями лежит, в режиме правки прямо супер.... И это работает через раз. И плохо, и права черт знает как, и какой объект кому. В общем в итоге все не очень выходит.
источник

NV

Nick Volynkin in DocOps-сообщество
А расскажите подробнее, с чем вы работаете?
источник

F

Fagor in DocOps-сообщество
Nick Volynkin
А расскажите подробнее, с чем вы работаете?
Документы с которыми я работаю имел в виду. Когда у меня 20 заинтересованных сторон, уровня исполнители. И каждый должне дать обратную связь. 20 не по всему, но в части документа проекта, коих до десяти. В некоторых доках строк (как объектов) - 1000, можно больше, но стараемся не расширять. Уже все, просто комментарии в док на шейрпоинте не вариант.
источник

NV

Nick Volynkin in DocOps-сообщество
А вы черновик пишете в шейрпойнте?
Насколько я понял Максима, он хочет комментирование готовой опубликованной документации, то есть веб-страниц.
источник

F

Fagor in DocOps-сообщество
Nick Volynkin
А вы черновик пишете в шейрпойнте?
Насколько я понял Максима, он хочет комментирование готовой опубликованной документации, то есть веб-страниц.
Ой, таких валом. Любой генератор. Grav без админки берите если с php проблем нет. Там и на js комментарии, они объектами в md к строке из md будут ложится (в шаблоне саязку yaml настроите), а потом git'от заберете из папки и любой ide по yaml сопоставите.

Но ради только готового дока, без общей среды, так себе вариант. Поднимать по grav на один док.

Я тоже хочу этого, но вижу что без того что описал по процессу составления самомого дока в целом, это мало решит проблему. Нужно и процесс составления и итоги комментирования, а потом итоги вернуть в ide и перерабатывать в итерации процесса составления. Но это мое ИМХО
источник

BF

Bobba Fett in DocOps-сообщество
Fagor
Да не плагин, если собрать поподробнее, давно витает в воздухе, ide для документов. Полноценное, с привязкой к фреймворкам сборки, но такого нет. Я даже понимаю почему, в чем отличие кода от дока. Тут еще "условную базу данных" прикручивать, прямо в ide. Так еще и в сборке во фронт обратно в базу возвращать некоторые изменения. В общем концепты в головах есть и по кусочкам и цельные, но в спрос никто не верит.
Это уже обсуждали. В теории можно генерить сайт с мапой элементов к исходникам, дальше фронтенд на js, который как раз берет комментарии ревьюера и создаёт например коммит с комментариями прямо в исходнике. Но это такая спец сборка сайта для ревьюера скорее всего. Можно запариться, но как вы заметили вряд ли это будет коммерчески оправданно делать в продукте, чисто как проект для опенсорсного пруф оф концепт. Я же спросил, что имелось в виду под плагином? Плагин с таким генератором, который собирает сайты с вот этим вот встроенным?
источник

BF

Bobba Fett in DocOps-сообщество
А ещё интересно, когда вы говорите про специализированную IDE, вы имеете в виду для авторинга, сборки и публикации? Чтобы была крутая поддержка маркдауна, интеграция с SSG, с CI/CD не переключаясь между тулами?
источник

NV

Nick Volynkin in DocOps-сообщество
Bobba Fett
А ещё интересно, когда вы говорите про специализированную IDE, вы имеете в виду для авторинга, сборки и публикации? Чтобы была крутая поддержка маркдауна, интеграция с SSG, с CI/CD не переключаясь между тулами?
Называется IDEA или VSCode. )
источник

BF

Bobba Fett in DocOps-сообщество
Nick Volynkin
Называется IDEA или VSCode. )
Какие плагины позволяют объединить весь стек?
источник

NV

Nick Volynkin in DocOps-сообщество
Bobba Fett
Какие плагины позволяют объединить весь стек?
Поддержка языков разметки — одноименные плагины. Интеграция с SSG — ещё плагины для языков шаблонизации, ну и консоль. И браузер на втором мониторе. А что там ещё интегрировать можно?
источник

F

Fagor in DocOps-сообщество
Nick Volynkin
Поддержка языков разметки — одноименные плагины. Интеграция с SSG — ещё плагины для языков шаблонизации, ну и консоль. И браузер на втором мониторе. А что там ещё интегрировать можно?
Например сразу вывод облако тегов и саязей, вызов ссылаемого тега. Сбор комментариев к доку в окне, полученных с сайта (фронта).

Но да, что то вроде intellej, только убрав все что не касается доков. И навесив кучу плагинов доков. Ну не нужно мне maven там. Дебагер тоже. А теги нужны, связи нужны как отдельное окно, диаграмма как код нужна (нормальный набор с норм визуалом), которая собирается по тегам из дока блоки. В общем это просто ИМХО. Но вот такое кажется нужно. Но коммерчески, пока не видится что будет.
источник