Size: a a a

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

2020 January 07

NV

Nick Volynkin in DocOps-сообщество
Pavel
Всем привет!


Можете скинуть ссылки /описать как этот подход docs as code интегрируется в SDLC?
И как пересекается с описанием требований от БА (требования задокументированы и должны быть выполнены разработчиком +/- , + возможные правки в документацию после)?
(Все вышеперечисленное, если мы не про  описание legacy)
Мы используем этот подход только для пользоватьской документации. Для проектной — vision, требования, отчёты об исследованиях, описание решений, RCA — используем Конфлюенс. У него есть интеграция с Джирой, управление доступом, комментарии и другие фичи, оптимальные для этих жанров.
источник

NP

Nikolaj Potashnikov in DocOps-сообщество
По pdf, мне кажется это важно, единственное найденное опен-сорсное решение https://github.com/JoshData/pdf-diff даёт не постраничный diff, а именно полноценное сравнение двух документов, а на выходе имеем png, в котором два документа (именно документы, а не вытащенный текст) стоят рядом с учетом постраничного смещения. Причём по тексту отмечено, что удалено, что добавлено.
источник

АП

Александр Парень in DocOps-сообщество
На слак-чате WTD увидел:

Some possible requirements for documentation tools
http://lauriston.com/requirements_sanitized.pdf
источник

L

Luiza in DocOps-сообщество
Pavel
Всем привет!


Можете скинуть ссылки /описать как этот подход docs as code интегрируется в SDLC?
И как пересекается с описанием требований от БА (требования задокументированы и должны быть выполнены разработчиком +/- , + возможные правки в документацию после)?
(Все вышеперечисленное, если мы не про  описание legacy)
По мне так отлично подходит для SDL- Security Development Lifecycle, там и прослеживаемость требований к коду, тестам, документам, уязвимостям должна быть, и идентификация точная, и версионность, кст у кого-то введен, вводится SDL?
источник
2020 January 08

NV

Nick Volynkin in DocOps-сообщество
Почитал. Много спорных требований. Например, раздел «Wiki collaboration». Можно было бы назвать это просто «collaboration», а слово «wiki» подразумевает конкретное решение задачи.
источник
2020 January 09

NV

Nick Volynkin in DocOps-сообщество
Коллеги, кто-нибудь делал пайплайн из Md в Confluence? Я умею только через Sphinx, но вдруг есть что-то именно для Md.
Знаю, что pandoc умеет конвертировать в разметку Confluence, но вроде бы запушить доки через API он не сможет.
источник

NV

Nick Volynkin in DocOps-сообщество
Привет, всем! Ведем документацию как проект в gitlab (не вики, а именно проект), оформляем с помощью Markdown. Заказчик поставил требование, чтобы информация из master-ветки была оформлена в виде отдельного пространства в Сonfluence и автоматически актуализировалась при обновлении master-ветки. Может кто сталкивался с подобной задачей, поделитесь, пожалуйста, опытом.
источник

NV

Nick Volynkin in DocOps-сообщество
@kvaleev Костя, а Foliant уже умеет в Confluence?
источник

K

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

EN

Ekaterina Noskova in DocOps-сообщество
почему нельзя через пайплайны-то дергать Confluence API и публиковать или обновлять страницу?
источник

K

Konstantin in DocOps-сообщество
В том числе с работать с комментариями. @Vanderhoof может рассказать поподробнее
источник

NV

Nick Volynkin in DocOps-сообщество
Ekaterina Noskova
почему нельзя через пайплайны-то дергать Confluence API и публиковать или обновлять страницу?
Ну да, можно. Вопрос, самим это кодить или уже есть что-то готовое.
источник

НН

Нац Нац in DocOps-сообщество
Ekaterina Noskova
почему нельзя через пайплайны-то дергать Confluence API и публиковать или обновлять страницу?
Пушо это надо самому писать всё, а хочется готовеньке
источник

iv

iakov v in DocOps-сообщество
Есть Ruby gem md2conf, например. Можно написать Rake task, который вызывать из gitlab ci
источник

iv

iakov v in DocOps-сообщество
источник

MD

Mazin Den in DocOps-сообщество
Продолжу про инструменты:
#usedoc
Внутренняя документация
- MkDocs (md) с расширениями, Confluence, Swagger
- CI/CD: drone, docker
- bitbucket
- Google Analytics
Пользовательская документация
- Confluence, ScreenSteps, в Word через gostdown
- Яндекс.Метрика

Хочется добавить линтеры и в дальнейшем попробовать Hugo
источник

НН

Нац Нац in DocOps-сообщество
впервые вижу gostdown, интересная штука
источник

MD

Mazin Den in DocOps-сообщество
Нац Нац
впервые вижу gostdown, интересная штука
очень выручила, когда внезапно заказчик захотел все по ГОСТ)
источник

НН

Нац Нац in DocOps-сообщество
Mazin Den
очень выручила, когда внезапно заказчик захотел все по ГОСТ)
Пошарю в канале, ато в чатах тут фигурируют ГОСТ-овики, вдруг кто-то захочет осовремениться
источник

AY

Andrei Yemelianov in DocOps-сообщество
Нац Нац
впервые вижу gostdown, интересная штука
штука любопытная (и мне может понадобиться в будущем)
источник