Techwriter Days — Мастер-класс: Портал с документацией своими руками

Subscribers:
8,980
Published on ● Video Link: https://www.youtube.com/watch?v=om4fBgMfMlg



Duration: 0:00
5 views
0


Никита Груздев

Я из команды технических писателей VK WorkSpace и один из авторов портала документации: https://biz.mail.ru/docs/on-premises/.

Расскажу, как любому техническому писателю можно перейти на подход docs-as-code и запустить веб-портал с документацией без помощи dev-ops'ов и разработчиков. Мы пройдем следующий путь:

Создадим свой первый портал с помощью языка Markdown и движка MkDocs.
Подключим популярную тему Material и кастомизируем портал: перекрасим в корпоративные цвета, заменим лого, подключим различные плагины и расширения.
Сложим весь результат нашей работы на Git.
С помощью GitHub Actions настроим деплой нашего портала в GitHub Pages и автоматизируем выкладку обновлений.

Факультативно я расскажу, как с помощью Docker подключать GitLab Runner'ы, чтобы пункт 4 работал если вы пользуетесь GitLab'ом.

Перед мастер-классом:
1. Заведите аккаунт на GitHub.
2. Установите Git: git-scm.com/download
3. Установите Python: www.python.org/downloads




Other Videos By SQA ANALYST TECHWRITER DAYS


2025-05-03SQA Days #35 — Николай Виноградов, Как тестируют железо
2025-05-03SQA Days #35 — Наталья Полякова, Почему у меня не получилось внедрить автоматизацию. Трижды
2025-05-03SQA Days #35 — Андрей Романюк, Релиз без сюрпризов: как мы уменьшили количество багов в проде
2025-05-03SQA Days #35 — Алексей Тюрин, От Android к мультиплатформе: простые и стабильные UI тесты с Ultron
2025-05-03SQA Days #35 — Александр Кидяев, Дмитрий Сорокин, ЕГР ЗАГС. Трансформация стратегии тестирования
2025-05-03SQA Days #35 — Алсу Шайдуллина, Путеводитель по менторству в ИТ: роль, сценарии и вызовы
2025-05-03SQA Days #35 — Александр Кондаков, Тестирование: модели и стандарты
2025-05-03SQA Days #35 — Алексей Иванов, Автоматизация фронтенда: от Junior до Senior
2025-05-03SQA Days #35 — Битва двух неклассических подходов к тестированию фичи:с чего начать и как закончить?
2025-05-03SQA Days #35 — Как устроены метрики показателей эффективности работы ПО и как их тестируют?
2025-05-02Techwriter Days — Мастер-класс: Портал с документацией своими руками
2025-04-27SQA Days 36. Краткий обзорный ролик
2025-04-25Анонс доклада Виталия Ефимова. Меняем тикетсы на шмикетсы: как мы тестируем ML-бота в Postgres Pro
2025-04-23Анонс доклада Артема Кузнецова. Топ 15 трендов UX/UI дизайна на 2025-2027 год
2025-04-15Краткий обзорный ролик TechWriter Days 2 - Первой Международной конференции технических писателей
2025-04-09Diplodoc золотой партнер TechWriter Days 2
2025-04-09Документерра серебряный партнер TechWriter Days 2
2025-04-03SQA Days #34 — Выбор модели и генерации тест кейсов. Всесторонний подход использования chatgpt
2025-03-13SQA Days #35 — Тестирование модели и стандарты
2025-03-13Analyst Days 19 — Оценка работ на этапе пресейла
2025-03-11SQA Days #35 — Self-healing скриншот-тесты: тесты для ленивых