Мастер-класс: Портал с документацией своими руками
-
-
1 ч 30 мин
Я из команды технических писателей VK WorkSpace и один из авторов портала документации: https://biz.mail.ru/docs/on-premises/.
Расскажу, как любому техническому писателю можно перейти на подход docs-as-code и запустить веб-портал с документацией без помощи dev-ops'ов и разработчиков. Мы пройдем следующий путь:
- Создадим свой первый портал с помощью языка Markdown и движка MkDocs.
- Подключим популярную тему Material и кастомизируем портал: перекрасим в корпоративные цвета, заменим лого, подключим различные плагины и расширения.
- Сложим весь результат нашей работы на Git.
- С помощью GitHub Actions настроим деплой нашего портала в GitHub Pages и автоматизируем выкладку обновлений.
Перед мастер-классом:
1. Заведите аккаунт на GitHub.
2. Установите Git: git-scm.com/download
3. Установите Python: www.python.org/downloads