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

  • 1 ч 30 мин

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


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

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


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


Перед мастер-классом:

1. Заведите аккаунт на GitHub.

2. Установите Git: git-scm.com/download

3. Установите Python: www.python.org/downloads


Комментарии ({{Comments.length}} )
  • {{comment.AuthorFullName}}
    {{comment.AuthorInfo}}
    {{ comment.DateCreated | date: 'dd.MM.yyyy' }}

Для того чтобы оставить комментарий необходимо

или
Напишите нам, мы онлайн!