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:
1 view
1984
616
1 month ago 00:19:38 1
Techwriter Days — Как новостные дайджесты делают работу технических писателей более видимой
1 month ago 00:46:21 1
Techwriter Days — Тех. писатели в сертификации. Взаимодействие с Минпромторгом и другими госорганами
1 month ago 00:20:19 1
Techwriter Days — Документация и код: что проще создавать в век ИИ?
1 month ago 01:01:00 1
Techwriter Days — Мастер-класс: Портал с документацией своими руками
1 month ago 00:42:53 1
Techwriter Days — Из технического писателя в UX-писателя: как научиться писать для интерфейсов
1 month ago 01:00:52 1
Techwriter Days — Мастер-класс: Создание статического сайта с помощью Hugo
1 month ago 00:55:07 1
Techwriter Days — ГОСТ 19 на практике
1 month ago 00:42:00 1
Techwriter Days — Как карта компетенций поможет сделать level up в профессии
1 month ago 00:23:29 1
Techwriter Days — Технический писатель vs тестировщик: кто лучше напишет ПМИ?
1 month ago 00:39:51 1
Techwriter Days — Зачем техническому писателю DocOps-инженер
1 month ago 00:56:07 1
Techwriter Days — Мастер-класс: Разворачиваем портал документации за 40 минут без технических знаний
1 month ago 00:39:23 1
Techwriter Days — Как приручить осьминога: мировые тренды в порталах документации
1 month ago 00:39:59 1
Techwriter Days — Путь к единому источнику или как можно унифицировать тексты в интерфейсе
1 month ago 00:40:48 1
Видео от TechWriter Days
1 month ago 00:35:15 1
Techwriter Days — Тексты в интерфейсах сложных B2B продуктов: как составить и где расположить
1 month ago 00:19:57 1
Techwriter Days — “Почему Тех. писатель - лучший друг QA-инж. и рук. проектов“
4 months ago 00:48:30 6
[SQA ANALYST TECHWRITER DAYS] Use Case VS User Story. Выбираем подход к специфицированию требований
6 months ago 00:00:00 1
[Flow Live] Что мы наблюдаем в отрасли SA/BA
6 months ago 00:42:46 211
Ревью технической документации. Алексей Лобзов
8 months ago 00:00:52 1
Краткий обзорный ролик TechWriter Days #1 - Первой Международной конференции технических писателей