Techwriter Days — Мастер-класс: Портал с документацией своими руками
Никита Груздев
Я из команды технических писателей VK WorkSpace и один из авторов портала документации:
Расскажу, как любому техническому писателю можно перейти на подход docs-as-code и запустить веб-портал с документацией без помощи dev-ops’ов и разработчиков. Мы пройдем следующий путь:
Создадим свой первый портал с помощью языка Markdown и движка MkDocs.
Подключим популярную тему Material и кастомизируем портал: перекрасим в корпоративные цвета, заменим лого, подключим различные плагины и расширения.
Сложим весь результат нашей работы на Git.
С помощью GitHub Actions настроим деплой нашего портала в GitHub Pages и автоматизируем выкладку обновлений.
Факультативно я расскажу, как с помощью Docker подключать GitLab Runner’ы, чтобы пункт 4 работал если вы пользуетесь GitLab’ом.
Перед мастер-классом:
1. Заведите аккаунт на GitHub.
2. Установите Git:
3. Установите Python:
23 views
1571
511
7 months ago 00:00:00 1
[Flow Live] Что мы наблюдаем в отрасли SA/BA
10 months ago 00:00:52 1
Краткий обзорный ролик TechWriter Days #1 - Первой Международной конференции технических писателей