L
Некоторые вещи тестами покрываются, например, отсутствие битых ссылок, отсутствие ошибок от линтера.
Size: a a a
2020 June 21
ЕД
Такое можно реализовать для документации, которая объясняет, как добиться конкретного результата
ЕД
Для которого все шаги по интерфейсу известны
ЕД
Можно селениумом или UIPAth проходить и сравнивать результат
ЕД
Но для этого нужно четко понимать профит от подобного, потому что усилий на создание и поддержку этого решения придется потратить много
ЕД
И понимать, есть ли антипрофит от того, что пользователь для каких-то сценариев не сможет завершить успешно
ЕД
И понимать целевую аудиторию документации - если это красноглазые rконсольные тараканы системные администраторы линукс, то они привыкли, что документация вено неактуальная
ЕД
А вот бизнес-пользователи чаще всего не могут и не должны искать обходные пути
ЕД
В общем, сложная тема
ML
Да, тоже интересно. тесткейсами документацию не покроешь
Мы сейчас постепенно делаем это.
Сниппеты конфига, запросы и скриншоты.
Еще у нас из документации во фронтенд выливаются хелп сниппеты и это тоже склеено автоматически.
Сделать это руками означает обречь проект на бесконечно сырое состояние
Сниппеты конфига, запросы и скриншоты.
Еще у нас из документации во фронтенд выливаются хелп сниппеты и это тоже склеено автоматически.
Сделать это руками означает обречь проект на бесконечно сырое состояние
IC
Коллеги, кто знаком с Antora, подскажите, есть ли возможность настроить автоматический процесс публикации в Netlify при коммитах в репозиторий в гите? На сайте в документации описана публикация в GitHub Pages. Но сами они свой сайт публикуют в нетлифай. Их netlify.toml не смог настроить под себя.
2020 June 22
ИЦ
🤔 я вот сейчас очередной раз уточнял, как будем оповещать об изменениях в документе (git, markdown, slack) и подумал:
дык надо в аттрибутах каждого файла прописывать, кого оповещать при изменениях — и пусть она кидает нотификации в нужный канал с меншном нужных людей/позиций.
Может быть моя мысль не оригинальна и уже есть где-то реализация?
дык надо в аттрибутах каждого файла прописывать, кого оповещать при изменениях — и пусть она кидает нотификации в нужный канал с меншном нужных людей/позиций.
Может быть моя мысль не оригинальна и уже есть где-то реализация?
ML
🤔 я вот сейчас очередной раз уточнял, как будем оповещать об изменениях в документе (git, markdown, slack) и подумал:
дык надо в аттрибутах каждого файла прописывать, кого оповещать при изменениях — и пусть она кидает нотификации в нужный канал с меншном нужных людей/позиций.
Может быть моя мысль не оригинальна и уже есть где-то реализация?
дык надо в аттрибутах каждого файла прописывать, кого оповещать при изменениях — и пусть она кидает нотификации в нужный канал с меншном нужных людей/позиций.
Может быть моя мысль не оригинальна и уже есть где-то реализация?
Это на уровне ci можно делать.
НН
Это на уровне ci можно делать.
Тоже подумалось
НН
GitHub actions + slackbot
ML
Но только вот оповещение само по себе плохой механизм.
Мы пытаемся уменьшить зловредную роль чатов: надо строить процессы, которые будут работать без чатов
Мы пытаемся уменьшить зловредную роль чатов: надо строить процессы, которые будут работать без чатов
FM
А если нет слака?
НН
Тогда и уведомления не нужны. Вуа-ля
VS
Но только вот оповещение само по себе плохой механизм.
Мы пытаемся уменьшить зловредную роль чатов: надо строить процессы, которые будут работать без чатов
Мы пытаемся уменьшить зловредную роль чатов: надо строить процессы, которые будут работать без чатов
Зачем?
ИЦ
да, можно сделать на уровне ci, и выглядит как будто правильно это делать там. А ещё нужно будет кучу нюансов продумать про то, в каких ситуациях что кидать, и как кастомизировать оповещения об обновлениях (релиз-мессаджи этакие) и т.п.