✱ Подходы, инструменты, стандарты
Мастер-класс: Портал с документацией своими руками
Techwriter Days #1
2024-04-05 16:40
Секция C
1 ч 30 мин
Средне
Спикеры
Доклад был на прошедшей конференции Techwriter Days #1 и сейчас находится в архиве.
Я из команды технических писателей 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
Доступно только после покупки 😊
Доступно только после покупки 😊